Skip to content

Commit 369b468

Browse files
conblemlivio-a
andauthored
chore: consistent naming for object ids (zitadel#11604)
<!-- Please inform yourself about the contribution guidelines on submitting a PR here: https://github.com/zitadel/zitadel/blob/main/CONTRIBUTING.md#submit-a-pull-request-pr. Take note of how PR/commit titles should be written and replace the template texts in the sections below. Don't remove any of the sections. It is important that the commit history clearly shows what is changed and why. Important: By submitting a contribution you agree to the terms from our Licensing Policy as described here: https://github.com/zitadel/zitadel/blob/main/LICENSING.md#community-contributions. --> # Which Problems Are Solved As part of the consistent naming effort, this PR focuses on Resource ID's. # How the Problems Are Solved Renamed generic Resource ID to matching Object + ID such as - Organization ID - User ID - Application ID - Identity Provider ID - Instance ID - Project ID # Additional Changes None # Additional Context - Closes zitadel#11306 --------- Co-authored-by: Livio Spring <livio.a@gmail.com>
1 parent 6ad1ef8 commit 369b468

35 files changed

Lines changed: 201 additions & 199 deletions

File tree

apps/docs/content/apis/openidoauth/authrequest.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -33,8 +33,8 @@ The <span className="text-yellow-500">Custom Domain</span> to your ZITADEL insta
3333
<p>
3434
<span className="text-green-500">Client ID</span> is the resource id of an
3535
application. It's the application where you want your users to login. You can
36-
find the resource id in the Console. When using project grants, use the
37-
client id from the origin organization.
36+
find the Client ID in the Console. When using project grants, use the
37+
Client ID from the origin organization.
3838
</p>
3939

4040
<p>

apps/docs/content/examples/imports/_app_jwt.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,6 +48,6 @@
4848
"clientId":"<YOUR_CLIENT_ID>"
4949
}
5050
```
51-
12. Also note down the **Resource ID** of your project.
51+
12. Also note down the **Project ID** of your project.
5252

5353
![](../../../public/img/examples/secure-api/app-jwt/11.png)

apps/docs/content/examples/login/nextjs-b2b.mdx

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -38,14 +38,14 @@ Let's call this one `portal-web`.
3838
Select `Web`, continue, `CODE`, then enter `http://localhost:3000/api/auth/callback/zitadel` for the redirect, and `http://localhost:3000` for the post redirect. Then press on `create`.
3939
Because the requests from your Next.js application to ZITADEL are made on the server side, you can safely select `CODE`. You will get a secret at the end of the stepper. With NextAuth your secret never gets exposed on the browser since it is kept in your Next.js server.
4040

41-
Copy the "Resource ID" of the project `Portal` as you will need this in your environment configuration file later.
41+
Copy the "Project ID" of the project `Portal` as you will need this in your environment configuration file later.
4242

4343
Click on the application `portal-web`.
4444
On the application detail page click on the section under redirect settings and enable `Development Mode`. This will allow you application to work on `localhost:3000`.
4545
To read the user data and roles from ID Token, go to the section Token Settings and make sure both checkboxes, `User roles inside ID Token` and `User Info inside ID Token` are enabled.
4646
Make sure to save your changes.
4747

48-
Copy the "Resource ID" of the application `portal-web` as you will need this in your environment configuration file later.
48+
Copy the "Application ID" of the application `portal-web` as you will need this in your environment configuration file later.
4949

5050
### Roles
5151

@@ -98,9 +98,9 @@ Replace the values as follows
9898

9999
`ZITADEL_API`: URL of the Management API. Typically, the same as `ZITADEL_ISSUER`.
100100

101-
`ORG_ID`: We will create an organization during later steps. You can find `${YOUR_ORG_ID}` by selecting the `Demo-Vendor` organization in Console. `${YOUR_ORG_ID}` is displayed on top of the organization detail page as "Resource ID".
101+
`ORG_ID`: We will create an organization during later steps. You can find `${YOUR_ORG_ID}` by selecting the `Demo-Vendor` organization in Console. `${YOUR_ORG_ID}` is displayed on top of the organization detail page as "Organization ID".
102102

103-
`PROJECT_ID`: You can find `${PROJECT_ID}` by clicking on "Projects" in the navigation and select the Project `Portal`. `${PROJECT_ID}` is displayed on the top as "Resource ID".
103+
`PROJECT_ID`: You can find `${PROJECT_ID}` by clicking on "Projects" in the navigation and select the Project `Portal`. `${PROJECT_ID}` is displayed on the top as "Project ID".
104104

105105
`ZITADEL_CLIENT_ID`: Having the project `Portal` selected, click on the Application `portal-web`. `${CLIENT_ID}` is displayed as a field in the OIDC settings, labeled "Client ID" and has the format `12345678@portal`.
106106

apps/docs/content/examples/login/react.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ After successful creation of the app, make sure copy the client ID, as you will
4242

4343
## Create a project role "admin" and assign it to your user
4444

45-
Also note the projects resource ID, as you will need it to configure your React application.
45+
Also note the Project ID, as you will need it to configure your React application.
4646

4747
![](../../../public/img/react/project-role.png)
4848

apps/docs/content/examples/login/vue.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ Also, copy the client ID, as you will need it to configure your Vue application.
4545

4646
## Create a project role "admin" and assign it to your user
4747

48-
Also note the projects resource ID, as you will need it to configure your Vue application.
48+
Also note the Project ID, as you will need it to configure your Vue application.
4949

5050
![](../../../public/img/vue/project-role.png)
5151

apps/docs/content/guides/integrate/token-introspection/basic-auth.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@ This is a guide on how to secure your API using [Basic Authentication](/apis/ope
5757
alt="Register the API"
5858
/>
5959

60-
7. Also note down the **Resource ID** of your project.
60+
7. Also note down the **Project ID** of your project.
6161

6262
<img
6363
src="/docs/img/guides/integrate/token-introspection-basic-auth-7.png"

apps/docs/content/guides/integrate/token-introspection/private-key-jwt.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -97,12 +97,12 @@ To use Private Key JWT for introspection, you must register your client applicat
9797
alt="OIDC Endpoints"
9898
/>
9999

100-
11. Optionally, note your **Resource ID** for reference.
100+
11. Optionally, note your **Project ID** for reference.
101101

102102
<img
103103
src="/docs/img/guides/integrate/token-introspection-jwt-profile-11.png"
104104
width="75%"
105-
alt="Resource ID"
105+
alt="Project ID"
106106
/>
107107

108108
## Calling the Introspection Endpoint

apps/docs/content/guides/manage/customize/behavior.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ Before you start, make sure you have everything set up correctly.
1717

1818
1. Select the **Projects** navigation item.
1919
2. Select a project that has a role configured.
20-
3. Copy the projects **Resource ID** on the screens top right.
20+
3. Copy the Project ID on the screens top right.
2121
4. Scroll to the **ROLES** section and note some roles key.
2222

2323
## Create the action

apps/docs/content/guides/migrate/sources/auth0.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ You'll need a target organization in ZITADEL to import your users. You can creat
2626
If you don't have a ZITADEL instance, you can [sign up for free here](https://zitadel.com) to create a new one for you.
2727
See: [Managing Organizations in ZITADEL](https://zitadel.com/docs/guides/manage/console/organizations-overview).
2828

29-
> **Note:** Copy your Organization ID (Resource ID) since you will use the id in the later steps.
29+
> **Note:** Copy your Organization ID since you will use the id in the later steps.
3030
3131
---
3232

apps/docs/content/guides/migrate/sources/keycloak.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ You'll need a target organization in ZITADEL to import your users. You can creat
3030
If you don't have a ZITADEL instance, you can [sign up for free here](https://zitadel.com) to create a new one for you.
3131
See: [Managing Organizations in ZITADEL](https://zitadel.com/docs/guides/manage/console/organizations-overview).
3232

33-
> **Note:** Copy your Organization ID (Resource ID) since you will use the id in the later steps.
33+
> **Note:** Copy your Organization ID since you will use the id in the later steps.
3434
3535
---
3636

0 commit comments

Comments
 (0)