mirror of
https://github.com/andwati/zitadel.git
synced 2026-10-28 10:02:15 +00:00
chore: consistent naming for object ids (#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 #11306 --------- Co-authored-by: Livio Spring <[email protected]>
This commit is contained in:
Ramon
Livio Spring
@@ -33,8 +33,8 @@ The <span className="text-yellow-500">Custom Domain</span> to your ZITADEL insta
|
||||
<p>
|
||||
<span className="text-green-500">Client ID</span> is the resource id of an
|
||||
application. It's the application where you want your users to login. You can
|
||||
find the resource id in the Console. When using project grants, use the
|
||||
client id from the origin organization.
|
||||
find the Client ID in the Console. When using project grants, use the
|
||||
Client ID from the origin organization.
|
||||
</p>
|
||||
|
||||
<p>
|
||||
|
||||
@@ -48,6 +48,6 @@
|
||||
"clientId":"<YOUR_CLIENT_ID>"
|
||||
}
|
||||
```
|
||||
12. Also note down the **Resource ID** of your project.
|
||||
12. Also note down the **Project ID** of your project.
|
||||
|
||||
|
||||
|
||||
@@ -38,14 +38,14 @@ Let's call this one `portal-web`.
|
||||
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`.
|
||||
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.
|
||||
|
||||
Copy the "Resource ID" of the project `Portal` as you will need this in your environment configuration file later.
|
||||
Copy the "Project ID" of the project `Portal` as you will need this in your environment configuration file later.
|
||||
|
||||
Click on the application `portal-web`.
|
||||
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`.
|
||||
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.
|
||||
Make sure to save your changes.
|
||||
|
||||
Copy the "Resource ID" of the application `portal-web` as you will need this in your environment configuration file later.
|
||||
Copy the "Application ID" of the application `portal-web` as you will need this in your environment configuration file later.
|
||||
|
||||
### Roles
|
||||
|
||||
@@ -98,9 +98,9 @@ Replace the values as follows
|
||||
|
||||
`ZITADEL_API`: URL of the Management API. Typically, the same as `ZITADEL_ISSUER`.
|
||||
|
||||
`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".
|
||||
`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".
|
||||
|
||||
`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".
|
||||
`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".
|
||||
|
||||
`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`.
|
||||
|
||||
|
||||
@@ -42,7 +42,7 @@ After successful creation of the app, make sure copy the client ID, as you will
|
||||
|
||||
## Create a project role "admin" and assign it to your user
|
||||
|
||||
Also note the projects resource ID, as you will need it to configure your React application.
|
||||
Also note the Project ID, as you will need it to configure your React application.
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -45,7 +45,7 @@ Also, copy the client ID, as you will need it to configure your Vue application.
|
||||
|
||||
## Create a project role "admin" and assign it to your user
|
||||
|
||||
Also note the projects resource ID, as you will need it to configure your Vue application.
|
||||
Also note the Project ID, as you will need it to configure your Vue application.
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -57,7 +57,7 @@ This is a guide on how to secure your API using [Basic Authentication](/apis/ope
|
||||
alt="Register the API"
|
||||
/>
|
||||
|
||||
7. Also note down the **Resource ID** of your project.
|
||||
7. Also note down the **Project ID** of your project.
|
||||
|
||||
<img
|
||||
src="/docs/img/guides/integrate/token-introspection-basic-auth-7.png"
|
||||
|
||||
@@ -97,12 +97,12 @@ To use Private Key JWT for introspection, you must register your client applicat
|
||||
alt="OIDC Endpoints"
|
||||
/>
|
||||
|
||||
11. Optionally, note your **Resource ID** for reference.
|
||||
11. Optionally, note your **Project ID** for reference.
|
||||
|
||||
<img
|
||||
src="/docs/img/guides/integrate/token-introspection-jwt-profile-11.png"
|
||||
width="75%"
|
||||
alt="Resource ID"
|
||||
alt="Project ID"
|
||||
/>
|
||||
|
||||
## Calling the Introspection Endpoint
|
||||
|
||||
@@ -17,7 +17,7 @@ Before you start, make sure you have everything set up correctly.
|
||||
|
||||
1. Select the **Projects** navigation item.
|
||||
2. Select a project that has a role configured.
|
||||
3. Copy the projects **Resource ID** on the screens top right.
|
||||
3. Copy the Project ID on the screens top right.
|
||||
4. Scroll to the **ROLES** section and note some roles key.
|
||||
|
||||
## Create the action
|
||||
|
||||
@@ -26,7 +26,7 @@ You'll need a target organization in ZITADEL to import your users. You can creat
|
||||
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.
|
||||
See: [Managing Organizations in ZITADEL](https://zitadel.com/docs/guides/manage/console/organizations-overview).
|
||||
|
||||
> **Note:** Copy your Organization ID (Resource ID) since you will use the id in the later steps.
|
||||
> **Note:** Copy your Organization ID since you will use the id in the later steps.
|
||||
|
||||
---
|
||||
|
||||
|
||||
@@ -30,7 +30,7 @@ You'll need a target organization in ZITADEL to import your users. You can creat
|
||||
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.
|
||||
See: [Managing Organizations in ZITADEL](https://zitadel.com/docs/guides/manage/console/organizations-overview).
|
||||
|
||||
> **Note:** Copy your Organization ID (Resource ID) since you will use the id in the later steps.
|
||||
> **Note:** Copy your Organization ID since you will use the id in the later steps.
|
||||
|
||||
---
|
||||
|
||||
|
||||
Reference in New Issue
Block a user