mirror of
https://github.com/andwati/zitadel.git
synced 2026-11-21 12:28:46 +00:00
chore: management console naming inconsistency (#11390)
# Which Problems Are Solved The following terms have all been renamed to management console: - Customer Portal (when used to mean the console) - Console - Admin Console # How the Problems Are Solved - Search & Replace smartly - Use Copilot for translation files Changes done to: backend + frontend codebase, docs, translations and protobufs (descriptions only) # Additional Context - Partially Closes #11279
This commit is contained in:
@@ -272,7 +272,7 @@ In the table below you can see the URI of those calls.
|
||||
|
||||
ZITADEL hosts everything under a single domain: `{instance}.zitadel.cloud` or your Custom Domain `${CUSTOM_DOMAIN}`
|
||||
|
||||
The domain is used as the OIDC issuer and as the base url for the gRPC and REST APIs, the Login and Console UI, which you'll find under `${CUSTOM_DOMAIN}/ui/console/`.
|
||||
The domain is used as the OIDC issuer and as the base url for the gRPC and REST APIs, the Login and Management Console UI, which you'll find under `${CUSTOM_DOMAIN}/ui/console/`.
|
||||
|
||||
Are you self-hosting and having troubles with _Instance not found_ errors? [Check out this page](/docs/self-hosting/manage/custom-domain).
|
||||
|
||||
|
||||
@@ -57,7 +57,7 @@ Following the [OIDC Core 1.0 specs](https://openid.net/specs/openid-connect-core
|
||||
the id_token will not contain any claims of the scopes `profile`, `email`, `phone` and `address`.
|
||||
|
||||
Send the access_token to the [userinfo_endpoint](#userinfo_endpoint) or [introspection_endpoint](#introspection_endpoint) the retrieve these claims
|
||||
or set the `id_token_userinfo_assertion` Option ("User Info inside ID Token" in Console) to true.
|
||||
or set the `id_token_userinfo_assertion` Option ("User Info inside ID Token" in Management Console) to true.
|
||||
:::
|
||||
|
||||
Depending on your authorization method you will have to provide additional parameters or headers:
|
||||
@@ -164,7 +164,7 @@ the error will be display directly to the user on the auth server
|
||||
| ------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| invalid_request | The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. |
|
||||
| invalid_scope | The requested scope is invalid. Typically the required `openid` value is missing. |
|
||||
| unauthorized_client | The client is not authorized to request an access_token using this method. Check in Console that the requested `response_type` is allowed in your application configuration. |
|
||||
| unauthorized_client | The client is not authorized to request an access_token using this method. Check in Management Console that the requested `response_type` is allowed in your application configuration. |
|
||||
| unsupported_response_type | The authorization server does not support the requested response_type. |
|
||||
| server_error | The authorization server encountered an unexpected condition that prevented it from fulfilling the request. |
|
||||
| interaction_required | The authorization server requires end-user interaction of some form to proceed. This error MAY be returned when the prompt parameter value in the Authentication Request is none, but the Authentication Request cannot be completed without displaying a user interface for end-user interaction. |
|
||||
|
||||
@@ -30,7 +30,7 @@ The service layer includes all components who are potentially exposed to consume
|
||||
|
||||
The http server is responsible for the following functions:
|
||||
|
||||
- serving the management GUI called Zitadel Console
|
||||
- serving the management GUI called Zitadel Management Console
|
||||
- serving the static assets
|
||||
- rendering server side html (login, password-reset, verification, ...)
|
||||
|
||||
|
||||
@@ -42,7 +42,7 @@ Go to your default settings and then click on the Tab **Events** to open the Eve
|
||||
|
||||
### Event API
|
||||
|
||||
Since everything that is available in Console can also be called with our APIs, you can access all events and audit data trough our APIs:
|
||||
Since everything that is available in Management Console can also be called with our APIs, you can access all events and audit data trough our APIs:
|
||||
|
||||
- [Event API Guide](/docs/guides/integrate/zitadel-apis/event-api)
|
||||
- [API Documentation](/docs/category/apis/resources/admin/events)
|
||||
|
||||
@@ -1,33 +1,33 @@
|
||||
---
|
||||
title: "ZITADEL Console: Resource management and customization"
|
||||
sidebar_label: Console
|
||||
title: "ZITADEL Management Console: Resource management and customization"
|
||||
sidebar_label: Management Console
|
||||
---
|
||||
|
||||
The ZITADEL console is a web-based interface designed to facilitate the management and administration of ZITADEL resources and configurations.
|
||||
The ZITADEL management console is a web-based interface designed to facilitate the management and administration of ZITADEL resources and configurations.
|
||||
It serves as a central hub where administrators can perform various tasks related to identity and access management within their organization's infrastructure.
|
||||
|
||||
The console is available by navigating to the [Custom Domain](/docs/concepts/features/custom-domain) of your instance and appending the path `/ui/console`.
|
||||
Administrators can [restrict end-users from accessing the console](/docs/guides/solution-scenarios/restrict-console).
|
||||
The management console is available by navigating to the [custom domain](/docs/concepts/features/custom-domain) of your instance and appending the path `/ui/console`.
|
||||
Administrators can [restrict end-users from accessing the management console](/docs/guides/solution-scenarios/restrict-console).
|
||||
|
||||
Here's an overview of what the console enables users to do:
|
||||
Here's an overview of what the management console enables users to do:
|
||||
|
||||
1. **Default Settings:** [Managers](/docs/concepts/structure/managers) can access and manage the default settings of the ZITADEL system. This includes configuring authentication methods, security policies, and other system-wide parameters to meet the organization's requirements.
|
||||
|
||||
2. **Resource Management:** The console allows for the creation, updating, and deletion of essential resources such as organizations, users, projects, and applications. Administrators can efficiently manage these entities to ensure proper access control and governance.
|
||||
2. **Resource Management:** The management console allows for the creation, updating, and deletion of essential resources such as organizations, users, projects, and applications. Administrators can efficiently manage these entities to ensure proper access control and governance.
|
||||
|
||||
3. **User Management:** Administrators can manage user accounts, including creating new user accounts, updating user profiles, resetting passwords, and deactivating or deleting user accounts as needed.
|
||||
|
||||
4. **Access Control:** The console provides tools for defining and managing access control policies. This includes assigning roles and permissions to users, configuring fine-grained access controls, and managing access to specific resources.
|
||||
4. **Access Control:** The management console provides tools for defining and managing access control policies. This includes assigning roles and permissions to users, configuring fine-grained access controls, and managing access to specific resources.
|
||||
|
||||
5. **Audit Logging:** The console offers access to [audit logs](/docs/concepts/features/audit-trail) that track user activity and changes made to resources and system settings. Administrators can review these logs to monitor security-related events, track changes, and maintain compliance with regulatory requirements.
|
||||
5. **Audit Logging:** The management console offers access to [audit logs](/docs/concepts/features/audit-trail) that track user activity and changes made to resources and system settings. Administrators can review these logs to monitor security-related events, track changes, and maintain compliance with regulatory requirements.
|
||||
|
||||
6. **Customization and Branding:** The console allows organizations to customize the branding and appearance of their ZITADEL instance. This includes uploading custom logos, selecting color schemes, and applying other visual customizations to align the interface with the organization's branding guidelines.
|
||||
6. **Customization and Branding:** The management console allows organizations to customize the branding and appearance of their ZITADEL instance. This includes uploading custom logos, selecting color schemes, and applying other visual customizations to align the interface with the organization's branding guidelines.
|
||||
|
||||
7. **Manager Assignment:** Administrators can assign ZITADEL [managers](/docs/concepts/structure/managers) who have elevated privileges for managing resources within the organization. This allows for the delegation of administrative tasks while maintaining proper oversight and control.
|
||||
|
||||
Overall, the ZITADEL console serves as a comprehensive tool for administrators to configure, manage, and monitor identity and access management within their organization, providing the necessary controls to ensure security, compliance, and efficient administration of resources.
|
||||
Overall, the ZITADEL management console serves as a comprehensive tool for administrators to configure, manage, and monitor identity and access management within their organization, providing the necessary controls to ensure security, compliance, and efficient administration of resources.
|
||||
|
||||
Notes:
|
||||
|
||||
- Detailed guide on [using the console](/docs/guides/manage/console/console-overview)
|
||||
- [Restrict access](/docs/guides/solution-scenarios/restrict-console) to the console
|
||||
- Detailed guide on [using the management console](/docs/guides/manage/console/console-overview)
|
||||
- [Restrict access](/docs/guides/solution-scenarios/restrict-console) to the management console
|
||||
|
||||
@@ -36,5 +36,5 @@ In some use cases, external user grants are a simple way to allow users access t
|
||||
## References
|
||||
|
||||
* [API reference for user grants](/docs/category/apis/resources/mgmt/user-grants)
|
||||
* [How to manage user grants through ZITADEL's console](/docs/guides/manage/console/roles#authorizations)
|
||||
* [How to manage user grants through ZITADEL's management console](/docs/guides/manage/console/roles#authorizations)
|
||||
* [More about multi-tenancy with ZITADEL](https://zitadel.com/blog/multi-tenancy-with-organizations)
|
||||
|
||||
@@ -74,5 +74,5 @@ To address this, ZITADEL provides generic templates that enable connection to vi
|
||||
### References
|
||||
|
||||
* [Detailed integration guide for many identity providers](/guides/integrate/identity-providers/introduction)
|
||||
* [Setup identity providers with Console](/guides/manage/console/default-settings#identity-providers)
|
||||
* [Setup identity providers with Management Console](/guides/manage/console/default-settings#identity-providers)
|
||||
* [Configure identity providers with the ZITADEL API](/docs/category/apis/resources/mgmt/identity-providers)
|
||||
|
||||
@@ -24,5 +24,5 @@ Ensure the configuration of application settings is limited to authorized users
|
||||
|
||||
## References
|
||||
|
||||
- [Configure Applications in the Console](../../guides/manage/console/applications-overview)
|
||||
- [Configure Applications in the Management Console](../../guides/manage/console/applications-overview)
|
||||
- [ZITADEL API: Applications](/docs/category/apis/resources/mgmt/applications)
|
||||
|
||||
@@ -8,7 +8,7 @@ import ProjectDescription from './\_project_description.mdx';
|
||||
|
||||
<ProjectDescription name="ProjectDescription" />
|
||||
|
||||
To learn how to set up a project read this console guide [here](../../guides/manage/console/projects-overview.mdx).
|
||||
To learn how to set up a project read this management console guide [here](../../guides/manage/console/projects-overview.mdx).
|
||||
|
||||
## Applications
|
||||
|
||||
@@ -29,7 +29,7 @@ More about granted projects: [Granted Projects](./granted_projects)
|
||||
|
||||
A role consists of different attributes. Only the key is relevant to the authorization and must therefore be unique.
|
||||
The display name is only to provide a human-readable name if needed.
|
||||
And the group should enable a better handling in ZITADEL console, like give a user all the roles of a specific group. (Not implemented yet)
|
||||
And the group should enable a better handling in ZITADEL management console, like give a user all the roles of a specific group. (Not implemented yet)
|
||||
|
||||
All applications in a project share the roles. Read more about roles [here](../../guides/manage/console/roles)
|
||||
|
||||
|
||||
@@ -77,6 +77,6 @@ You can use organization metadata or your own business logic to describe a hiera
|
||||
|
||||
## References
|
||||
|
||||
- [Manage users in the Console](../../guides/manage/console/users-overview)
|
||||
- [Manage users in the Management Console](../../guides/manage/console/users-overview)
|
||||
- [ZITADEL APIs: Users](/docs/category/apis/resources/mgmt/users)
|
||||
- [User onboarding and registration](/docs/guides/integrate/onboarding)
|
||||
|
||||
@@ -8,7 +8,7 @@ It explains how to enable user login in your application and how to fetch data f
|
||||
|
||||
By the end of this guide, your application will have login functionality and will be able to access the current user's profile.
|
||||
|
||||
> This documentation references our [example](https://github.com/zitadel/zitadel-angular) on GitHub. Please note that we wrote the ZITADEL Console in Angular, so you can also use that as a reference.
|
||||
> This documentation references our [example](https://github.com/zitadel/zitadel-angular) on GitHub. Please note that we wrote the ZITADEL Management Console in Angular, so you can also use that as a reference.
|
||||
|
||||
## Set up application and obtain keys
|
||||
|
||||
@@ -17,7 +17,7 @@ You'll need to provide some information about your app. We recommend creating a
|
||||
Select the **User Agent** application type and continue.
|
||||
We recommend that you use [Proof Key for Code Exchange (PKCE)](/apis/openidoauth/grant-types#proof-key-for-code-exchange) for all SPA applications.
|
||||
|
||||

|
||||

|
||||
|
||||
|
||||
### Redirect URIs
|
||||
@@ -147,7 +147,7 @@ https://github.com/zitadel/zitadel-angular/blob/main/src/app/components/user/use
|
||||
|
||||
### Refresh token
|
||||
|
||||
If you want to add a refresh token to your application, navigate to the console application and check the box in the configuration section.
|
||||
If you want to add a refresh token to your application, navigate to the management console application and check the box in the configuration section.
|
||||
Then add `offline_access` to the scopes and add the following line:
|
||||
|
||||
```
|
||||
@@ -163,10 +163,10 @@ Congratulations! You have successfully integrated your Angular application with
|
||||
|
||||
If you get stuck, consider checking out our [example](https://github.com/zitadel/zitadel-angular) application. This application includes all the functionalities mentioned in this quick-start. You can start by cloning the repository and replacing the _AuthConfig_ in the _AppModule_ with your own configuration. If you face issues, contact us or raise an issue on [GitHub](https://github.com/zitadel/zitadel).
|
||||
|
||||

|
||||

|
||||
|
||||
### What's next?
|
||||
|
||||
Now that you have enabled authentication, it's time for you to add authorization to your application using ZITADEL APIs. To do this, you can refer to the [docs](/apis/introduction) or check out the ZITADEL Console code on [GitHub](https://github.com/zitadel/zitadel) which uses gRPC to access data.
|
||||
Now that you have enabled authentication, it's time for you to add authorization to your application using ZITADEL APIs. To do this, you can refer to the [docs](/apis/introduction) or check out the ZITADEL Management Console code on [GitHub](https://github.com/zitadel/zitadel) which uses gRPC to access data.
|
||||
|
||||
For more information on how to create an Angular application, you can refer to [Angular](https://angular.io/start). If you want to learn more about the OAuth/OIDC library used above, consider reading the docs at [angular-oauth2-oidc](https://github.com/manfredsteyer/angular-oauth2-oidc).
|
||||
@@ -16,7 +16,7 @@ Before we can start building our application, we have to do a few configuration
|
||||
You will need to provide some information about your app. We recommend creating a new app to start from scratch. Navigate to your Project, then add a new application at the top of the page.
|
||||
Select **Native** application type and continue.
|
||||
|
||||

|
||||

|
||||
|
||||
### Redirect URIs
|
||||
|
||||
|
||||
@@ -21,11 +21,11 @@ Before we begin developing our application, we need to perform a few configurati
|
||||
You'll need to provide some information about your app. We recommend creating a new app to start from scratch. Navigate to your Project, then add a new application at the top of the page.
|
||||
Select the **Web** application type and continue.
|
||||
|
||||

|
||||

|
||||
|
||||
We recommend that you use [Proof Key for Code Exchange (PKCE)](/apis/openidoauth/grant-types#proof-key-for-code-exchange) for all applications.
|
||||
|
||||

|
||||

|
||||
|
||||
### Redirect URIs
|
||||
|
||||
@@ -34,7 +34,7 @@ The Post-logout redirect send the users back to a route on your application afte
|
||||
|
||||
> If you are following along with the [example](https://github.com/zitadel/zitadel-go), set the dev mode to `true`, the Redirect URIs to `http://localhost:8089/auth/callback` and Post-logout redirect URI to [http://localhost:8089/](http://localhost:8089/)>.
|
||||
|
||||

|
||||

|
||||
|
||||
Continue and create the application.
|
||||
|
||||
@@ -42,7 +42,7 @@ Continue and create the application.
|
||||
|
||||
After successful creation of the app, a pop-up will appear displaying the app's client ID. Copy the client ID, as you will need it to configure your Go client.
|
||||
|
||||

|
||||

|
||||
|
||||
## Go setup
|
||||
|
||||
|
||||
@@ -19,11 +19,11 @@ Before we begin developing our application, we need to perform a few configurati
|
||||
You'll need to provide some information about your app. We recommend creating a new app to start from scratch. Navigate to your Project, then add a new application at the top of the page.
|
||||
Select the **Web** application type and continue.
|
||||
|
||||

|
||||

|
||||
|
||||
We recommend that you use [Proof Key for Code Exchange (PKCE)](/apis/openidoauth/grant-types#proof-key-for-code-exchange) for all applications.
|
||||
|
||||

|
||||

|
||||
|
||||
### Redirect URIs
|
||||
|
||||
@@ -34,7 +34,7 @@ The Post-logout redirect send the users back to a route on your application afte
|
||||
If you are following along with the [example](https://github.com/zitadel/zitadel-java), set the dev mode to `true`, the Redirect URIs to `http://localhost:18080/webapp/login/oauth2/code/zitadel` and Post redirect URI to `http://localhost:18080/webapp`.
|
||||
:::
|
||||
|
||||

|
||||

|
||||
|
||||
Continue and create the application.
|
||||
|
||||
@@ -42,7 +42,7 @@ Continue and create the application.
|
||||
|
||||
After successful creation of the app, a pop-up will appear displaying the app's client ID. Copy the client ID, as you will need it to configure your Java client.
|
||||
|
||||

|
||||

|
||||
|
||||
## Spring setup
|
||||
|
||||
|
||||
@@ -31,7 +31,7 @@ Enter the name `Demo-Vendor`, and click "Create". Then click on that organizatio
|
||||
|
||||
To setup this sample you have to create a project and an application in the vendor organization (`Demo-Vendor`) first.
|
||||
|
||||
Open the Console (`https://$CUSTOM_DOMAIN.zitadel.cloud/ui/console/projects`) and create a new project. Let's call it `Portal`.
|
||||
Open the Management Console (`https://$CUSTOM_DOMAIN.zitadel.cloud/ui/console/projects`) and create a new project. Let's call it `Portal`.
|
||||
|
||||
Then on the project detail page click on new application and enter a name for this app.
|
||||
Let's call this one `portal-web`.
|
||||
@@ -62,7 +62,7 @@ This makes sure that roles, which is used by the application to enable UI compon
|
||||
### Service User
|
||||
|
||||
To make the application work you need a service user which loads granted-projects and user-grants for you.
|
||||
In the B2B-Demo organization, navigate to `Users` in navigation of Console, click on `Service Users` and create a new user.
|
||||
In the B2B-Demo organization, navigate to `Users` in navigation of Management Console, click on `Service Users` and create a new user.
|
||||
Let's set its username to `nextjs` and its name to `NextJS`. Then press `create`.
|
||||
|
||||
On the detail page of that user, navigate to "Personal Access Tokens" and add a new entry, set an optional expiration date.
|
||||
|
||||
@@ -35,7 +35,7 @@ Select Web application type and continue.
|
||||
We use [Authorization Code](/apis/openidoauth/grant-types#authorization-code)for our NextJS application.
|
||||
Select `CODE` in the next step. This makes sure you still get a secret. Note that the secret never gets exposed on the browser and is therefore kept in a confidential environment.
|
||||
|
||||

|
||||

|
||||
|
||||
### Redirect URIs
|
||||
|
||||
|
||||
@@ -18,7 +18,7 @@ This documentation references our [example](https://github.com/zitadel/example-d
|
||||
|
||||
## ZITADEL setup
|
||||
|
||||
Before we can start building our application, we have to do a few configuration steps in ZITADEL Console.
|
||||
Before we can start building our application, we have to do a few configuration steps in ZITADEL Management Console.
|
||||
|
||||
### Project roles
|
||||
|
||||
@@ -30,7 +30,7 @@ This example expects 3 different roles:
|
||||
|
||||
In your project settings make sure the "Assert Roles On Authentication" is enabled.
|
||||
|
||||

|
||||

|
||||
|
||||
In the project Role tab, add 3 special roles:
|
||||
|
||||
@@ -40,11 +40,11 @@ In the project Role tab, add 3 special roles:
|
||||
|
||||
If none of the roles is provided as a user, the user in Django will not be created.
|
||||
|
||||

|
||||

|
||||
|
||||
Finally, we can assign the roles to users in the project's authorizations tab.
|
||||
|
||||

|
||||

|
||||
|
||||
### Set up application and obtain secrets
|
||||
|
||||
@@ -54,11 +54,11 @@ In your Project, add a new application at the top of the page.
|
||||
Select Web application type and continue.
|
||||
We use [Authorization Code](/apis/openidoauth/grant-types#authorization-code) for our Django application.
|
||||
|
||||

|
||||

|
||||
|
||||
Select `CODE` in the next step. This makes sure you still get a secret. Note that the secret never gets exposed on the browser and is therefore kept in a confidential environment. Safe the generated secret for later use.
|
||||
|
||||

|
||||

|
||||
|
||||
With the Redirect URIs field, you tell ZITADEL where it is allowed to redirect users to after authentication. For development, you can set dev mode to `true` to enable insecure HTTP and redirect to a `localhost` URI.
|
||||
|
||||
@@ -67,7 +67,7 @@ For the example application we are writing use:
|
||||
- `http://localhost:8000/oidc/callback/` as Redirect URI
|
||||
- `http://localhost:8000/oidc/logout/` as post-logout URI.
|
||||
|
||||

|
||||

|
||||
|
||||
After the final step you are presented with a client ID and secret.
|
||||
Copy and paste them to a safe location for later use by the application.
|
||||
@@ -238,4 +238,4 @@ If you get stuck, consider checking out our [example](https://github.com/zitadel
|
||||
|
||||
### What's next?
|
||||
|
||||
Now that you have enabled authentication, it's time for you to add more authorizations to your application using ZITADEL APIs. To do this, you can refer to the [docs](/apis/introduction) or check out the ZITADEL Console code on [GitHub](https://github.com/zitadel/zitadel) which uses gRPC and OpenAPI to access data.
|
||||
Now that you have enabled authentication, it's time for you to add more authorizations to your application using ZITADEL APIs. To do this, you can refer to the [docs](/apis/introduction) or check out the ZITADEL Management Console code on [GitHub](https://github.com/zitadel/zitadel) which uses gRPC and OpenAPI to access data.
|
||||
|
||||
@@ -22,7 +22,7 @@ Navigate to your project, then add a new application at the top of the page.
|
||||
Select the **User Agent** application type and continue.
|
||||
We recommend that you use [Proof Key for Code Exchange (PKCE)](/apis/openidoauth/grant-types#proof-key-for-code-exchange) for all single page applications.
|
||||
|
||||

|
||||

|
||||
|
||||
### Redirect URIs
|
||||
|
||||
@@ -109,12 +109,12 @@ This application includes all the functionalities mentioned in this quickstart.
|
||||
You can start by cloning the repository and changing the arguments to `createZitadelAuth` to fit your requirements.
|
||||
If you face issues, contact us or [raise an issue on GitHub](https://github.com/zitadel/zitadel-react/issues).
|
||||
|
||||

|
||||

|
||||
|
||||
### What's next?
|
||||
|
||||
Now that you have enabled authentication, you are ready to add authorization to your application by using ZITADEL APIs.
|
||||
To do this, [refer to the API docs](/apis/introduction) or check out [the ZITADEL Console code on GitHub](https://github.com/zitadel/zitadel) which uses gRPC to access data.
|
||||
To do this, [refer to the API docs](/apis/introduction) or check out [the ZITADEL Management Console code on GitHub](https://github.com/zitadel/zitadel) which uses gRPC to access data.
|
||||
|
||||
For more information on how to create a React application, you can refer to [Create React App](https://github.com/facebook/create-react-app).
|
||||
If you want to learn more about the libraries wrapped by [@zitadel/react](https://www.npmjs.com/package/@zitadel/react), read the docs for [oidc-client-ts](https://github.com/authts/oidc-client-ts).
|
||||
|
||||
@@ -27,7 +27,7 @@ Inside ZITADEL, you can use regular lower-case role names without prefixes, if y
|
||||
|
||||
In your project settings make sure the "Assert Roles On Authentication" is enabled.
|
||||
|
||||

|
||||

|
||||
|
||||
In the project Role tab, add 2 special roles:
|
||||
|
||||
@@ -36,11 +36,11 @@ In the project Role tab, add 2 special roles:
|
||||
|
||||
A `user` role is not required. This role is assumed by default for any authenticated user in Symfony.
|
||||
|
||||

|
||||

|
||||
|
||||
Finally, we can assign the roles to users in the project's authorizations tab.
|
||||
|
||||

|
||||

|
||||
|
||||
### Set up application and obtain secrets
|
||||
|
||||
@@ -50,11 +50,11 @@ In your Project, add a new application at the top of the page.
|
||||
Select Web application type and continue.
|
||||
We use [Authorization Code](/apis/openidoauth/grant-types#authorization-code)for our Symfony application.
|
||||
|
||||

|
||||

|
||||
|
||||
Select `CODE` in the next step. This makes sure you still get a secret. Note that the secret never gets exposed on the browser and is therefore kept in a confidential environment. Safe the generated
|
||||
|
||||

|
||||

|
||||
|
||||
With the Redirect URIs field, you tell ZITADEL where it is allowed to redirect users to after authentication. For development, you can set dev mode to `true` to enable insecure HTTP and redirect to a `localhost` URI.
|
||||
|
||||
@@ -63,7 +63,7 @@ For the example application we are writing use:
|
||||
- `http://localhost:8000/login_check` as Redirect URI
|
||||
- `http://localhost:8000/logout` as post-logout URI.
|
||||
|
||||

|
||||

|
||||
|
||||
After the final step you are presented with a client ID and secret.
|
||||
Copy and paste them to a safe location for later use by the application.
|
||||
@@ -405,4 +405,4 @@ If you get stuck, consider checking out our [example](https://github.com/zitadel
|
||||
|
||||
### What's next?
|
||||
|
||||
Now that you have enabled authentication, it's time for you to add more authorizations to your application using ZITADEL APIs. To do this, you can refer to the [docs](/apis/introduction) or check out the ZITADEL Console code on [GitHub](https://github.com/zitadel/zitadel) which uses gRPC and OpenAPI to access data.
|
||||
Now that you have enabled authentication, it's time for you to add more authorizations to your application using ZITADEL APIs. To do this, you can refer to the [docs](/apis/introduction) or check out the ZITADEL Management Console code on [GitHub](https://github.com/zitadel/zitadel) which uses gRPC and OpenAPI to access data.
|
||||
|
||||
@@ -15,14 +15,14 @@ It also uses the @zitadel/vue package with its default configuration.
|
||||
|
||||
## Set up application and obtain keys
|
||||
|
||||
Before we begin developing our application, we need to perform a few configuration steps in the ZITADEL Console.
|
||||
Before we begin developing our application, we need to perform a few configuration steps in the ZITADEL Management Console.
|
||||
You'll need to provide some information about your app.
|
||||
We recommend creating a new app to start from scratch.
|
||||
Navigate to your project, then add a new application at the top of the page.
|
||||
Select the **User Agent** application type and continue.
|
||||
We recommend that you use [Proof Key for Code Exchange (PKCE)](/apis/openidoauth/grant-types#proof-key-for-code-exchange) for all single page applications.
|
||||
|
||||

|
||||

|
||||
|
||||
### Redirect URIs
|
||||
|
||||
@@ -118,12 +118,12 @@ This application includes all the functionalities mentioned in this quickstart.
|
||||
You can start by cloning the repository and change the arguments to createZITADELAuth so they fit your requirements.
|
||||
If you face issues, contact us or [raise an issue on GitHub](https://github.com/zitadel/zitadel-vue/issues).
|
||||
|
||||

|
||||

|
||||
|
||||
### What's next?
|
||||
|
||||
Now that you have enabled authentication, you are ready to call add authorization to your application using ZITADEL APIs.
|
||||
To do this, [refer to the API docs](/apis/introduction) or check out [the ZITADEL Console code on GitHub](https://github.com/zitadel/zitadel) which uses gRPC to access data.
|
||||
To do this, [refer to the API docs](/apis/introduction) or check out [the ZITADEL Management Console code on GitHub](https://github.com/zitadel/zitadel) which uses gRPC to access data.
|
||||
|
||||
For more information on how to create an Vue application, you can refer to [Vue](https://vuejs.org/guide/quick-start.html).
|
||||
If you want to learn more about the libraries wrapped by [@zitadel/vue](https://www.npmjs.com/package/@zitadel/vue), [read the docs for vue-oidc-client](https://github.com/soukoku/vue-oidc-client/wiki/V1-Docs).
|
||||
|
||||
@@ -24,7 +24,7 @@ All that is required, is to create your API, create a private key and a personal
|
||||
Before we begin developing our API, we need to perform a few configuration steps in the ZITADEL Console.
|
||||
You'll need to provide some information about your app. We recommend creating a new app to start from scratch.
|
||||
|
||||
Starting from the homepage of your console, click on Create Application
|
||||
Starting from the homepage of your management console, click on Create Application
|
||||
|
||||

|
||||
|
||||
@@ -199,17 +199,17 @@ permission denied: missing required role: `admin`
|
||||
|
||||
### Add administrator role
|
||||
|
||||
So let's create the role and grant it to the user. To do so, go to your project in ZITADEL Console
|
||||
So let's create the role and grant it to the user. To do so, go to your project in ZITADEL Management Console
|
||||
and create the role by selecting `Roles` in the navigation and then clicking on the `New Role` button.
|
||||
Finally, create the role as shown below:
|
||||
|
||||

|
||||

|
||||
|
||||
After you have created the role, let's grant it the user, who requested the tasks.
|
||||
Click on `Authorization` in the navigation and create a new one by selecting the user and the `admin` role.
|
||||
After successful creation, it should look like:
|
||||
|
||||

|
||||

|
||||
|
||||
So you should now be able to add a new task:
|
||||
|
||||
|
||||
@@ -19,15 +19,15 @@ Before we begin developing our API, we need to perform a few configuration steps
|
||||
You'll need to provide some information about your app. We recommend creating a new app to start from scratch. Navigate to your Project, then add a new application at the top of the page.
|
||||
Select the **API** application type and continue.
|
||||
|
||||

|
||||

|
||||
|
||||
Select Basic Auth for authenticating at the Introspection Endpoint.
|
||||
|
||||

|
||||

|
||||
|
||||
After successful creation of the app, a pop-up will appear displaying the app's client ID. Copy the client ID and secret, as you will need it to configure your Java client.
|
||||
|
||||

|
||||

|
||||
|
||||
## Spring Setup
|
||||
|
||||
@@ -220,17 +220,17 @@ Date: Mon, 15 Jan 2024 09:24:39 GMT
|
||||
|
||||
### Add administrator role
|
||||
|
||||
So let's create the role and grant it to the user. To do so, go to your project in ZITADEL Console
|
||||
So let's create the role and grant it to the user. To do so, go to your project in ZITADEL Management Console
|
||||
and create the role by selecting `Roles` in the navigation and then clicking on the `New Role` button.
|
||||
Finally, create the role as shown below:
|
||||
|
||||

|
||||

|
||||
|
||||
After you have created the role, let's grant it the user, who requested the tasks.
|
||||
Click on `Authorization` in the navigation and create a new one by selecting the user and the `admin` role.
|
||||
After successful creation, it should look like:
|
||||
|
||||

|
||||

|
||||
|
||||
So you should now be able to add a new task:
|
||||
|
||||
|
||||
@@ -14,7 +14,7 @@ By the end of this guide, your application will have three different endpoint wh
|
||||
|
||||
## ZITADEL setup
|
||||
|
||||
Before we can start building our application, we have to do a few configuration steps in ZITADEL Console.
|
||||
Before we can start building our application, we have to do a few configuration steps in ZITADEL Management Console.
|
||||
|
||||
### Create application
|
||||
|
||||
@@ -113,7 +113,7 @@ AUTH_ISSUER='https://example.zitadel.cloud'
|
||||
AUTH_PROJECT_ID='250719519163548112'
|
||||
```
|
||||
|
||||
2. Copy the `.json`-key-file that you downloaded from the ZITADEL Console into the root folder of your project and rename it to `key.json`.
|
||||
2. Copy the `.json`-key-file that you downloaded from the ZITADEL Management Console into the root folder of your project and rename it to `key.json`.
|
||||
|
||||
3. (Optional) For added convenience in production environments, you can include the content of the .json key file as `AUTH_KEY` in the .env file or as an environment variable.
|
||||
|
||||
|
||||
@@ -19,7 +19,7 @@ This documentation references our [example](https://github.com/zitadel/example-d
|
||||
|
||||
## ZITADEL setup
|
||||
|
||||
Before we can start building our application, we have to do a few configuration steps in ZITADEL Console.
|
||||
Before we can start building our application, we have to do a few configuration steps in ZITADEL Management Console.
|
||||
|
||||
### Create application
|
||||
|
||||
|
||||
@@ -116,7 +116,7 @@ curl -L -X PUT 'https://${CUSTOM_DOMAIN}/v2/actions/executions' \
|
||||
|
||||
## Example call
|
||||
|
||||
Now that you have set up the target and execution, you can test it by creating a user through the Console UI or
|
||||
Now that you have set up the target and execution, you can test it by creating a user through the Management Console UI or
|
||||
by calling the ZITADEL API to create a human user.
|
||||
|
||||
```shell
|
||||
|
||||
@@ -142,7 +142,7 @@ curl -L -X PUT 'https://${CUSTOM_DOMAIN}/v2/actions/executions' \
|
||||
|
||||
## Example call
|
||||
|
||||
Now that you have set up the target and execution, you can test it by logging into Console UI or
|
||||
Now that you have set up the target and execution, you can test it by logging into Management Console UI or
|
||||
by using any OIDC flow.
|
||||
|
||||
As a result 3 things happen:
|
||||
|
||||
@@ -120,7 +120,7 @@ curl -L -X PUT 'https://${CUSTOM_DOMAIN}/v2/actions/executions' \
|
||||
|
||||
## Example call
|
||||
|
||||
Now that you have set up the target and execution, you can test it by logging into Console UI or
|
||||
Now that you have set up the target and execution, you can test it by logging into Management Console UI or
|
||||
by using any OIDC flow.
|
||||
|
||||
Your server should now print out something like the following. Check out the [Sent information Function](./usage#sent-information-function) payload description.
|
||||
|
||||
@@ -170,7 +170,7 @@ curl -L -X PUT 'https://${CUSTOM_DOMAIN}/v2/actions/executions' \
|
||||
|
||||
## Example call
|
||||
|
||||
Now that you have set up the target and execution, you can test it by creating a user through the Console UI or
|
||||
Now that you have set up the target and execution, you can test it by creating a user through the Management Console UI or
|
||||
by calling the ZITADEL API to create a human user.
|
||||
|
||||
```shell
|
||||
|
||||
@@ -153,7 +153,7 @@ You can do this by using **Webhook.site** (see [Creating a Listener with Webhook
|
||||
|
||||
## Example call
|
||||
|
||||
Now that you have set up the target and execution, you can test it by creating a user through the Console UI or
|
||||
Now that you have set up the target and execution, you can test it by creating a user through the Management Console UI or
|
||||
by calling the ZITADEL API to create a human user.
|
||||
|
||||
```shell
|
||||
|
||||
@@ -120,7 +120,7 @@ curl -L -X PUT 'https://${CUSTOM_DOMAIN}/v2/actions/executions' \
|
||||
|
||||
## Example call
|
||||
|
||||
Now that you have set up the target and execution, you can test it by creating a user through the Console UI or
|
||||
Now that you have set up the target and execution, you can test it by creating a user through the Management Console UI or
|
||||
by calling the ZITADEL API to create a human user.
|
||||
|
||||
```shell
|
||||
|
||||
@@ -120,7 +120,7 @@ curl -L -X PUT 'https://${CUSTOM_DOMAIN}/v2/actions/executions' \
|
||||
|
||||
## Example call
|
||||
|
||||
Now that you have set up the target and execution, you can test it by creating a user through the Console UI or
|
||||
Now that you have set up the target and execution, you can test it by creating a user through the Management Console UI or
|
||||
by calling the ZITADEL API to create a human user.
|
||||
|
||||
```shell
|
||||
|
||||
@@ -137,7 +137,7 @@ curl -L -X PUT 'https://${CUSTOM_DOMAIN}/v2/actions/executions' \
|
||||
|
||||
## 7. Example Call
|
||||
|
||||
Now that you have set up the target and execution, you can test it by creating a user through the Console UI or by calling the ZITADEL API to create a human user.
|
||||
Now that you have set up the target and execution, you can test it by creating a user through the Management Console UI or by calling the ZITADEL API to create a human user.
|
||||
|
||||
Here, we are creating a user via the API:
|
||||
|
||||
|
||||
@@ -20,7 +20,7 @@ You will need to provide some information about your app. We recommend creating
|
||||
|
||||
Your application configuration should now look similar to this:
|
||||
|
||||

|
||||

|
||||
|
||||
## Setup Custom JWT Provider for MongoDB Charts
|
||||
|
||||
|
||||
@@ -103,7 +103,7 @@ Once in the settings:
|
||||
Access the settings page of your instance or the specific organization and select **Identity Providers**.
|
||||
|
||||
|
||||
The ZITADEL Console will display a list of all the IdPs you've configured, along with available provider templates. Selecting any listed IdP will guide you through the process of configuring that specific Identity Provider.
|
||||
The ZITADEL Management Console will display a list of all the IdPs you've configured, along with available provider templates. Selecting any listed IdP will guide you through the process of configuring that specific Identity Provider.
|
||||
|
||||

|
||||
|
||||
|
||||
@@ -50,7 +50,7 @@ Developers can configure the authentication methods offered on the login page ba
|
||||
|
||||
### Enterprise single-sign-on
|
||||
|
||||

|
||||

|
||||
|
||||
With the hosted login page from ZITADEL developers will get the best support for multi-tenancy single-sign-on with third-party identity providers.
|
||||
ZITADEL acts as an [identity broker](/docs/concepts/features/identity-brokering) between your applications and different external identity providers, reducing the implementation effort for developers.
|
||||
|
||||
@@ -124,4 +124,4 @@ Main reasons why developers might want to build their own login UI include:
|
||||
|
||||
- Learn how to [register and onboard users](/docs/guides/integrate/onboarding)
|
||||
- Learn how to [build your own login UI](/docs/guides/integrate/login-ui) based on ZITADEL
|
||||
- Learn how to [configure ZITADEL](/docs/guides/manage/console/console-overview) through the Console
|
||||
- Learn how to [configure ZITADEL](/docs/guides/manage/console/console-overview) through the Management Console
|
||||
|
||||
@@ -11,7 +11,7 @@ or environments we recommend using the `state` parameter for the former and mult
|
||||
To initialize the user authentication, you will have to create an authorization request using HTTP GET in the user agent (browser)
|
||||
on /authorize with at least the following parameters:
|
||||
|
||||
- `client_id`: this tells the authorization server which application it is, copy from Console
|
||||
- `client_id`: this tells the authorization server which application it is, copy from Management Console
|
||||
- `redirect_uri`: where the authorization code is sent to after the user authentication, must be one of the registered in the previous step
|
||||
- `response_type`: if you want to have a code (authorization code flow) or directly a token (implicit flow), so when ever possible use `code`
|
||||
- `scope`: what scope you want to grant to the access_token / id_token, minimum is `openid`, if you're unsure what you need you might start with `openid profile email`
|
||||
|
||||
@@ -22,7 +22,7 @@ or environments we recommend using the `state` parameter for the former and mult
|
||||
To initialize the user authentication, you will have to create an authorization request using HTTP GET in the user agent (browser)
|
||||
on /authorize with at least the following parameters:
|
||||
|
||||
- `client_id`: this tells the authorization server which application it is, copy from Console
|
||||
- `client_id`: this tells the authorization server which application it is, copy from Management Console
|
||||
- `redirect_uri`: where the authorization code is sent to after the user authentication, must be one of the registered in the previous step
|
||||
- `response_type`: if you want to have a code (authorization code flow) or directly a token (implicit flow), so when ever possible use `code`
|
||||
- `scope`: what scope you want to grant to the access_token / id_token, minimum is `openid`, if you're unsure what you need you might start with `openid profile email`
|
||||
|
||||
@@ -11,7 +11,7 @@ or environments we recommend using the `state` parameter for the former and mult
|
||||
To initialize the user authentication, you will have to create an authorization request using HTTP GET in the user agent (browser)
|
||||
on /authorize with at least the following parameters:
|
||||
|
||||
- `client_id`: this tells the authorization server which application it is, copy from Console
|
||||
- `client_id`: this tells the authorization server which application it is, copy from Management Console
|
||||
- `redirect_uri`: where the authorization code is sent to after the user authentication, must be one of the registered in the previous step
|
||||
- `response_type`: if you want to have a code (authorization code flow) or directly a token (implicit flow), so when ever possible use `code`
|
||||
- `scope`: what scope you want to grant to the access_token / id_token, minimum is `openid`, if you're unsure what you need you might start with `openid profile email`
|
||||
|
||||
@@ -11,7 +11,7 @@ or environments we recommend using the `state` parameter for the former and mult
|
||||
To initialize the user authentication, you will have to create an authorization request using HTTP GET in the user agent (browser)
|
||||
on /authorize with at least the following parameters:
|
||||
|
||||
- `client_id`: this tells the authorization server which application it is, copy from Console
|
||||
- `client_id`: this tells the authorization server which application it is, copy from Management Console
|
||||
- `redirect_uri`: where the authorization code is sent to after the user authentication, must be one of the registered in the previous step
|
||||
- `response_type`: if you want to have a code (authorization code flow) or directly a token (implicit flow), so when ever possible use `code`
|
||||
- `scope`: what scope you want to grant to the access_token / id_token, minimum is `openid`, if you're unsure what you need you might start with `openid profile email`
|
||||
|
||||
@@ -17,7 +17,7 @@ ZITADEL offers a comprehensive identity and access management solution, providin
|
||||
|
||||
## Getting Started
|
||||
|
||||
To begin integrating your application with Zitadel using RFC 8628, follow the steps outlined in this documentation. We'll walk you through the process, from setting up your application in the Zitadel console to handling user authentication and access tokens in your application code.
|
||||
To begin integrating your application with Zitadel using RFC 8628, follow the steps outlined in this documentation. We'll walk you through the process, from setting up your application in the Zitadel management console to handling user authentication and access tokens in your application code.
|
||||
|
||||
1. Go to “Organization”/”Projects”.
|
||||
2. Under “Applications” click the “New” button.
|
||||
|
||||
@@ -46,7 +46,7 @@ This flow is the same when using PKCE or JWT with Private Key for authentication
|
||||
|
||||
## Create Application
|
||||
|
||||
To create an application, open your project in Console and start by clicking on the "New" button in the Application section.
|
||||
To create an application, open your project in Management Console and start by clicking on the "New" button in the Application section.
|
||||
|
||||
#### Application type
|
||||
|
||||
@@ -88,7 +88,7 @@ When selecting Native the authentication method always needs to be PKCE.
|
||||
#### Authentication method
|
||||
|
||||
When selecting SPA the recommended authentication method is again PKCE. All common Frameworks like Angular, React, Vue.js and so on
|
||||
are able to successfully authenticate with PKCE. Our management UI Console for instance uses PKCE as well.
|
||||
are able to successfully authenticate with PKCE. Our management console UI for instance uses PKCE as well.
|
||||
|
||||
<AuthMethods selected="spa" />
|
||||
</TabItem>
|
||||
|
||||
@@ -85,7 +85,7 @@ To show how you can use the self-management possibilities it is shown from the c
|
||||
The Administrator user received an initialization e-mail after the user was created.
|
||||
With the link in the email the admin will be able to setup a password and optionally some multi-factors.
|
||||
|
||||
As the administrator only has permission for its own organization the ZITADEL Console UI does look slightly different.
|
||||
As the administrator only has permission for its own organization the ZITADEL Management Console UI does look slightly different.
|
||||
|
||||
To invite a team member the admin has to repeat the steps you did before.
|
||||
1. [Create User](./b2b#create-user)
|
||||
|
||||
@@ -6,18 +6,18 @@ sidebar_label: Retrieve User Roles
|
||||
This guide explains all the possible ways of retrieving user roles across different organizations and projects using ZITADEL's APIs.
|
||||
|
||||
## What are roles/authorizations/grants in ZITADEL?
|
||||
User roles, user grants, or authorizations refer to the roles that are assigned to a user. These terms are used interchangeably to mean the roles assigned to the user, e.g., the ZITADEL Console refers to the pairing of roles and users as authorizations, whereas the APIs refer to them as grants. This guide will use the term roles for application-specific roles (e.g., `admin`, `accountant`, `employee`, `hr`, etc.) and ZITADEL-specific administrator roles (e.g., `IAM_OWNER`, `ORG_OWNER`, `PROJECT_OWNER`, etc.).
|
||||
User roles, user grants, or authorizations refer to the roles that are assigned to a user. These terms are used interchangeably to mean the roles assigned to the user, e.g., the ZITADEL Management Console refers to the pairing of roles and users as authorizations, whereas the APIs refer to them as grants. This guide will use the term roles for application-specific roles (e.g., `admin`, `accountant`, `employee`, `hr`, etc.) and ZITADEL-specific administrator roles (e.g., `IAM_OWNER`, `ORG_OWNER`, `PROJECT_OWNER`, etc.).
|
||||
|
||||
Roles are critical to managing permissions in a single-tenant or multi-tenant application. It can, however, be tricky to retrieve them, especially when spanning multiple organizations and projects.
|
||||
|
||||
## Assign roles and memberships
|
||||
|
||||
Human or service users can be assigned roles. You can do this via the ZITADEL Console or the ZITADEL APIs. As mentioned earlier, there are two types of roles in ZITADEL. You can have your own application-specific roles, and alternatively, ZITADEL also has administrator roles, such as `ORG_OWNER` and `IAM_OWNER`.
|
||||
Human or service users can be assigned roles. You can do this via the ZITADEL Management Console or the ZITADEL APIs. As mentioned earlier, there are two types of roles in ZITADEL. You can have your own application-specific roles, and alternatively, ZITADEL also has administrator roles, such as `ORG_OWNER` and `IAM_OWNER`.
|
||||
|
||||
Follow the links below to assign roles to your users.
|
||||
|
||||
- [Add application roles via the ZITADEL Console](/docs/guides/manage/console/roles)
|
||||
- [Add administrator roles via the ZITADEL Console](/docs/guides/manage/console/managers)
|
||||
- [Add application roles via the ZITADEL Management Console](/docs/guides/manage/console/roles)
|
||||
- [Add administrator roles via the ZITADEL Management Console](/docs/guides/manage/console/managers)
|
||||
- [Add application roles via the ZITADEL Management API](/docs/category/apis/resources/mgmt/project-roles)
|
||||
- [Add administrator roles to users via the ZITADEL Management API](/docs/category/apis/resources/mgmt/members)
|
||||
|
||||
@@ -34,7 +34,7 @@ How to generate a token:
|
||||
- [Generate tokens for human users](/docs/guides/integrate/login/oidc/login-users)
|
||||
- [Generate tokens for service users](/docs/guides/integrate/service-users/authenticate-service-users)
|
||||
|
||||
In order to access role information via the token you must include the right audience and the necessary role claims in the scope and/or select the required role settings in the ZITADEL console before requesting the token.
|
||||
In order to access role information via the token you must include the right audience and the necessary role claims in the scope and/or select the required role settings in the ZITADEL management console before requesting the token.
|
||||
|
||||
### Determine the audience
|
||||
|
||||
@@ -60,7 +60,7 @@ Let's assume you have a frontend application and a backend application under dif
|
||||
|
||||
And you can also use the same to access the ZITADEL APIs.
|
||||
|
||||
### Role settings in the ZITADEL Console
|
||||
### Role settings in the ZITADEL Management Console
|
||||
|
||||
If you need user roles returned from the userinfo endpoint, you must select the **’Assert Roles on Authentication’** checkbox in your project under general settings.
|
||||
|
||||
|
||||
@@ -44,7 +44,7 @@ curl --request POST \
|
||||
* `CUSTOM_DOMAIN` should be set to your [Custom Domain](/docs/concepts/features/custom-domain)
|
||||
* `grant_type` should be set to `client_credentials`
|
||||
* `scope` should contain any [Scopes](/apis/openidoauth/scopes) you want to include, but must include `openid`. For this example, please include `profile`
|
||||
* `CLIENT_ID` and `CLIENT_SECRET` should be set with the values shown in Console when generating a new secret to enable [basic authentication](/docs/apis/openidoauth/authn-methods)
|
||||
* `CLIENT_ID` and `CLIENT_SECRET` should be set with the values shown in Management Console when generating a new secret to enable [basic authentication](/docs/apis/openidoauth/authn-methods)
|
||||
|
||||
If you want to access ZITADEL APIs, make sure to include the required scopes `urn:zitadel:iam:org:project:id:zitadel:aud`.
|
||||
Read our guide [how to access ZITADEL APIs](../zitadel-apis/access-zitadel-apis) to learn more.
|
||||
|
||||
@@ -46,7 +46,7 @@ You can let ZITADEL generate a private key for you, **or** upload your own (exte
|
||||
|
||||
#### Option A: Generate and download a private key from ZITADEL
|
||||
|
||||
1. Open the ZITADEL web console and go to your service user.
|
||||
1. Open the ZITADEL web management console and go to your service user.
|
||||
2. Click on the **Keys** tab.
|
||||
3. Click **New**.
|
||||
4. Optionally set an expiration date for the key, or leave empty for no expiration.
|
||||
|
||||
@@ -18,7 +18,7 @@ Prerequisites:
|
||||
- existing Atlassian Access setup, including verified domain
|
||||
|
||||
> We have to switch between ZITADEL and Atlassian. If the headings begin with "ZITADEL" switch to the ZITADEL
|
||||
> Console and
|
||||
> Management Console and
|
||||
> if the headings start with "Atlassian" please switch to the Atlassian Admin GUI.
|
||||
|
||||
## **Atlassian**: Create a new external identity provider
|
||||
|
||||
@@ -19,7 +19,7 @@ Prerequisites:
|
||||
- existing ZITADEL project, if not present follow the first 3 steps [here](/guides/manage/console/projects-overview)
|
||||
- existing Auth0 tenant as described [here](https://auth0.com/docs/get-started/auth0-overview/create-tenants)
|
||||
|
||||
> We have to switch between ZITADEL and a Auth0. If the headings begin with "ZITADEL" switch to the ZITADEL Console and if the headings start with "Auth0" please switch to the Auth0 GUI.
|
||||
> We have to switch between ZITADEL and a Auth0. If the headings begin with "ZITADEL" switch to the ZITADEL Management Console and if the headings start with "Auth0" please switch to the Auth0 GUI.
|
||||
|
||||
## **Auth0**: Create a new connection
|
||||
|
||||
@@ -35,7 +35,7 @@ The configuration should look like this:
|
||||
|
||||

|
||||
|
||||
Next we have to switch to the ZITADEL console.
|
||||
Next we have to switch to the ZITADEL Management Console.
|
||||
|
||||
## **ZITADEL**: Create the application
|
||||
|
||||
|
||||
@@ -17,7 +17,7 @@ Prerequisites:
|
||||
- existing ZITADEL project, if not present follow the first 3 steps [here](/guides/manage/console/projects-overview)
|
||||
- existing Auth0 tenant as described [here](https://auth0.com/docs/get-started/auth0-overview/create-tenants)
|
||||
|
||||
> We have to switch between ZITADEL and a Auth0. If the headings begin with "ZITADEL" switch to the ZITADEL Console and
|
||||
> We have to switch between ZITADEL and a Auth0. If the headings begin with "ZITADEL" switch to the ZITADEL Management Console and
|
||||
> if the headings start with "Auth0" please switch to the Auth0 GUI.
|
||||
|
||||
## **Auth0**: Create a new connection
|
||||
|
||||
@@ -18,7 +18,7 @@ Prerequisites:
|
||||
- prerequisites on AWS side [here](https://docs.aws.amazon.com/singlesignon/latest/userguide/prereqs.html).
|
||||
- enabled AWS SSO [here](https://docs.aws.amazon.com/singlesignon/latest/userguide/step1.html?icmpid=docs_sso_console)
|
||||
|
||||
> We have to switch between ZITADEL and a AWS. If the headings begin with "ZITADEL" switch to the ZITADEL Console and if
|
||||
> We have to switch between ZITADEL and a AWS. If the headings begin with "ZITADEL" switch to the ZITADEL Management Console and if
|
||||
> the headings start with "AWS" please switch to the AWS GUI.
|
||||
|
||||
## **AWS**: Change to external identity provider ZITADEL
|
||||
|
||||
@@ -18,7 +18,7 @@ Prerequisites:
|
||||
- existing Gitlab SaaS Setup in the premium tier
|
||||
|
||||
> We have to switch between ZITADEL and Gitlab. If the headings begin with "ZITADEL" switch to the ZITADEL
|
||||
> Console and
|
||||
> Management Console and
|
||||
> if the headings start with "Gitlab" please switch to the Gitlab GUI.
|
||||
|
||||
## **Gitlab**: Create a new external identity provider
|
||||
|
||||
@@ -20,7 +20,7 @@ Prerequisites:
|
||||
- existing ZITADEL project, if not present follow the first 3 steps [here](/guides/manage/console/projects-overview)
|
||||
- prerequisites on Google Cloud side [in the configuration guide](https://cloud.google.com/iam/docs/configuring-workforce-identity-federation).
|
||||
|
||||
> We have to switch between ZITADEL and a Google Cloud. If the headings begin with "ZITADEL" switch to the ZITADEL Console and if
|
||||
> We have to switch between ZITADEL and a Google Cloud. If the headings begin with "ZITADEL" switch to the ZITADEL Management Console and if
|
||||
> the headings start with "Google Cloud" please refer to the configuration guide on Google Cloud.
|
||||
|
||||
## **Google Cloud**: Configure
|
||||
|
||||
@@ -18,7 +18,7 @@ Prerequisites:
|
||||
- existing Pingidentity environment [here](https://docs.pingidentity.com/bundle/pingone/page/wqe1564020490538.html)
|
||||
|
||||
> We have to switch between ZITADEL and Ping Identity. If the headings begin with "ZITADEL" switch to the ZITADEL
|
||||
> Console and
|
||||
> Management Console and
|
||||
> if the headings start with "Ping" please switch to the PingIdentity GUI.
|
||||
|
||||
## **Ping**: Create a new external identity provider
|
||||
|
||||
@@ -218,7 +218,7 @@ For this example we have the following projects in our organization:
|
||||
- **portal** contains the end user interfaces. In this case a web-app that initiated user login and performs operations on other APIs. The web-app has the token exchange grant type enabled;
|
||||
- **aggregates** a project that contains APIs of low privilege which aggregate public data to return to the user;
|
||||
- **settings** a project that contains APIs for settings and other privileged operations;
|
||||
- **ZITADEL** the build-in project used for the zitadel console and APIs;
|
||||
- **ZITADEL** the build-in project used for the zitadel management console and APIs;
|
||||
|
||||
#### Authenticated user tokens
|
||||
|
||||
@@ -880,7 +880,7 @@ Above we gave some of the most straightforward use cases. Of course, you can com
|
||||
|
||||
## Audit trail
|
||||
|
||||
In the user view of the console we can see whenever a new access token is created for a user.
|
||||
In the user view of the management console we can see whenever a new access token is created for a user.
|
||||
The existing `Access Token created` event is also used in the case of a token exchange.
|
||||
When there was an `actor_token` present during token exchange, we also log a `User impersonated` event.
|
||||
|
||||
|
||||
@@ -49,9 +49,9 @@ The System API can't be accessed by service users and requires a special configu
|
||||
|
||||
## 1. Create a service user
|
||||
|
||||
First, you need to create a new service user through the console or ZITADEL APIs.
|
||||
First, you need to create a new service user through the management console or ZITADEL APIs.
|
||||
|
||||
Via Console:
|
||||
Via Management Console:
|
||||
|
||||
1. In an organization, navigate to Users > Service Users
|
||||
2. Click on **New**
|
||||
|
||||
@@ -46,7 +46,7 @@ Change the program.cs file to the content below. This will create a client for t
|
||||
The SDK will make sure you will have access to the API by retrieving a Bearer Token using JWT Profile with the provided scopes (`openid` and `urn:zitadel:iam:org:project:id:zitadel:aud`).
|
||||
|
||||
Make sure to fill the const `apiUrl`, and `personalAccessToken` with your own instance data. The used vars below are from a test instance, to show you how it should look.
|
||||
The apiURL is the domain of your instance you can find it on the instance detail in the Customer Portal or in the Console
|
||||
The apiURL is the domain of your instance you can find it on the instance detail in the Customer Portal or in the Management Console
|
||||
|
||||
```csharp
|
||||
// This file contains two examples:
|
||||
|
||||
@@ -5,7 +5,7 @@ import TabItem from "@theme/TabItem";
|
||||
|
||||
:::note
|
||||
If you started with Zitadel before version 3, you might have the "Human User [deprecated]" UI.
|
||||
In this case please enable the Feature Flag "Use V2 Api in Console for User creation" in the Default Settings.
|
||||
In this case please enable the Feature Flag "Use V2 Api in Management Console for User creation" in the Default Settings.
|
||||
:::
|
||||
|
||||
<Tabs>
|
||||
@@ -43,6 +43,6 @@ In this case please enable the Feature Flag "Use V2 Api in Console for User crea
|
||||
|
||||
You can prompt the user to add a second factor method too by checking the **Force MFA** toggle in [Login behaviour settings](/docs/guides/manage/console/default-settings#login-behavior-and-access).
|
||||
|
||||
When logged in, a user can then manage the profile in the console, adding a profile picture, external IDPs and Passkeys.
|
||||
When logged in, a user can then manage the profile in the management console, adding a profile picture, external IDPs and Passkeys.
|
||||
|
||||
<img src="/docs/img/guides/console/myprofile.png" alt="Profile Self Manage" />
|
||||
|
||||
@@ -58,7 +58,7 @@ You can use the following built-in modules inside your JavaScript code:
|
||||
|
||||
Stuck customizing ZITADEL actions? Find samples for setting OIDC claims, SAML attributes, extending JIT provisioning data, calling external APIs, and more in [this repository](https://github.com/zitadel/actions).
|
||||
|
||||
## Managing Actions in Console
|
||||
## Managing Actions in Management Console
|
||||
|
||||
### 1. Create an Action
|
||||
|
||||
|
||||
@@ -15,7 +15,7 @@ Applications are the entry point to your [Project](projects-overview.mdx). Users
|
||||
|
||||
All applications within a project share the same **Roles** and **Authorizations**. This means you define a role once (e.g., `admin`) on the Project level, and it applies across all your web, mobile, and API applications.
|
||||
|
||||
To access your applications, navigate to your Project in the Console and select your application.
|
||||
To access your applications, navigate to your Project in the Management Console and select your application.
|
||||
|
||||
<img
|
||||
alt="Granted project"
|
||||
@@ -139,7 +139,7 @@ When IPv6 URIs are used as redirects in development mode, square brackets must b
|
||||
|
||||
After creating an application, you can modify its configuration.
|
||||
* **Auth Method:** You can switch authentication methods (e.g., from Basic to Private Key JWT) via the toggle or dropdowns.
|
||||
* **OIDC Compliance:** The Console checks if your configuration is OIDC compliant and shows tasks for completion if anything is missing.
|
||||
* **OIDC Compliance:** The Management Console checks if your configuration is OIDC compliant and shows tasks for completion if anything is missing.
|
||||
|
||||
:::caution
|
||||
You **cannot** change the Application Type (e.g., from Web to Native) after creation. You must delete and recreate the application.
|
||||
|
||||
@@ -1,24 +1,24 @@
|
||||
---
|
||||
title: Console
|
||||
sidebar_label: Console
|
||||
title: Management Console
|
||||
sidebar_label: Management Console
|
||||
---
|
||||
|
||||
## Overview
|
||||
|
||||
The ZITADEL Console is the web-based Dashboard UI designed to facilitate the management and administration of ZITADEL resources and configurations. It serves as a central hub where [Managers](/docs/concepts/structure/managers) can perform tasks related to identity and access management, configure authentication methods, and manage the organization's infrastructure.
|
||||
The ZITADEL Management Console is the web-based Dashboard UI designed to facilitate the management and administration of ZITADEL resources and configurations. It serves as a central hub where [Managers](/docs/concepts/structure/managers) can perform tasks related to identity and access management, configure authentication methods, and manage the organization's infrastructure.
|
||||
|
||||
While the Console is primarily a tool for administrators, it can also be accessed by end-users to manage their own profiles (e.g., password reset, MFA setup), unless you [restrict access](/docs/guides/solution-scenarios/restrict-console) to build your own custom UI.
|
||||
While the Management Console is primarily a tool for administrators, it can also be accessed by end-users to manage their own profiles (e.g., password reset, MFA setup), unless you [restrict access](/docs/guides/solution-scenarios/restrict-console) to build your own custom UI.
|
||||
|
||||
## Accessing the Console
|
||||
## Accessing the Management Console
|
||||
|
||||
The console is available by navigating to the [Custom Domain](/docs/concepts/features/custom-domain) of your instance and appending the path `/ui/console`.
|
||||
The management console is available by navigating to the [Custom Domain](/docs/concepts/features/custom-domain) of your instance and appending the path `/ui/console`.
|
||||
|
||||
## Navigation and Context
|
||||
|
||||
When logged in, you are greeted by the home page, which allows you to set shortcuts to frequently used settings and projects.
|
||||
|
||||
### Context Switcher
|
||||
ZITADEL is a multi-tenant system. The Console features a **Context Switcher** in the **top-left** corner. This allows you to switch between the different **Organizations** you manage.
|
||||
ZITADEL is a multi-tenant system. The Management Console features a **Context Switcher** in the **top-left** corner. This allows you to switch between the different **Organizations** you manage.
|
||||
|
||||
Depending on your use case:
|
||||
* **B2C:** You might stick to your global organization.
|
||||
@@ -34,7 +34,7 @@ To understand how to structure your organizations, read our [Solution Scenario](
|
||||
|
||||
## Key Capabilities
|
||||
|
||||
The Console enables administrators to perform the following critical tasks:
|
||||
The Management Console enables administrators to perform the following critical tasks:
|
||||
|
||||
1. **Default Settings:** Managers can configure global system defaults. This includes authentication methods, security policies (like password complexity or lockout policies), and other system-wide parameters.
|
||||
2. **Resource Management:** Create, update, and delete essential resources such as [Organizations](./organizations-overview), [Projects](./projects-overview), and [Applications](./applications-overview).
|
||||
@@ -46,11 +46,11 @@ The Console enables administrators to perform the following critical tasks:
|
||||
|
||||
## Security and Restrictions
|
||||
|
||||
### Prevent Console Access
|
||||
In many implementations, specifically white-label B2C scenarios, you may want to prevent end-users from accessing the generic ZITADEL Console entirely.
|
||||
### Prevent Management Console Access
|
||||
In many implementations, specifically white-label B2C scenarios, you may want to prevent end-users from accessing the generic ZITADEL Management Console entirely.
|
||||
|
||||
Administrators can restrict access to the console, forcing users to interact only with your own applications or custom user interfaces.
|
||||
Please follow the [Restrict Console Access guide](/docs/guides/solution-scenarios/restrict-console) to achieve this.
|
||||
Administrators can restrict access to the management console, forcing users to interact only with your own applications or custom user interfaces.
|
||||
Please follow the [Restrict Management Console Access guide](/docs/guides/solution-scenarios/restrict-console) to achieve this.
|
||||
|
||||
## References
|
||||
|
||||
|
||||
@@ -44,7 +44,7 @@ If a feature is set to `Inherit`, it becomes available once its enabled per defa
|
||||
width="700px"
|
||||
/>
|
||||
|
||||
Features can range from UI changes in the console, to new APIs or performance improvements.
|
||||
Features can range from UI changes in the management console, to new APIs or performance improvements.
|
||||
|
||||
:::warning
|
||||
Be careful on which features you enable as they can be in an experimental state.
|
||||
@@ -61,7 +61,7 @@ In the Branding settings, you can upload you Logo for the login interface, set y
|
||||
| Setting | Description |
|
||||
| ----------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| Logo | Upload your logo for the light and the dark design. This is used mainly in the login interface. |
|
||||
| Icon | Upload your icon for the light and the dark design. Icons are used for smaller components. For example in console on the top left as the home button. |
|
||||
| Icon | Upload your icon for the light and the dark design. Icons are used for smaller components. For example in management console on the top left as the home button. |
|
||||
| Colors | You can set four different colors to design your login page and email. (Background-, Primary-, Warn- and Font Color) |
|
||||
| Font | Upload your custom font |
|
||||
| Advanced Behavior | **Hide Loginname suffix**: If enabled, your loginname suffix (Domain) will not be shown in the login page. **Disable Watermark**: If you disable the watermark you will not see the "Powered by ZITADEL" in the login page |
|
||||
@@ -163,7 +163,7 @@ Reasons why ZITADEL doesn't have a redirect URI:
|
||||
- The login has not been called with an OIDC authorize request
|
||||
- The user landed on the login through an email link, e.g. Password Reset, Initialize User
|
||||
|
||||
We recommend setting your own default redirect URI, if you do not want end users to access ZITADEL console.
|
||||
We recommend setting your own default redirect URI, if you do not want end users to access ZITADEL Management Console.
|
||||
|
||||
Change default redirect url of instance: `https://${CUSTOM_DOMAIN}/ui/console/instance?id=login`
|
||||
|
||||
@@ -258,7 +258,7 @@ The following settings are available:
|
||||
- Maximum Password Attempts: When the user has reached the maximum password attempts the account will be locked, If this is set to 0 the lockout will not trigger.
|
||||
- Maximum OTP Attempts: When the user has reached the maximum (T)OTP attempts the account will be locked, If this is set to 0 the lockout will not trigger.
|
||||
|
||||
If an account is locked, the administrator has to unlock it in the ZITADEL console
|
||||
If an account is locked, the administrator has to unlock it in the ZITADEL Management Console
|
||||
|
||||
<img src="/docs/img/guides/console/lockout.png" alt="Lockout" width="600px" />
|
||||
|
||||
@@ -309,7 +309,7 @@ Example:
|
||||
width="600px"
|
||||
/>
|
||||
|
||||
Also you can set the link associated to the Documentation button in the console. Set an empty text if you don't want to show a Documentation button in your console. If you need a custom button to be shown in the console you can set the button text and the link associated to the button (if the button text is button no text will be shown).
|
||||
Also you can set the link associated to the Documentation button in the console. Set an empty text if you don't want to show a Documentation button in your console. If you need a custom button to be shown in the management console you can set the button text and the link associated to the button (if the button text is button no text will be shown).
|
||||
|
||||
<img
|
||||
src="/docs/img/guides/console/external_links_2.png"
|
||||
|
||||
@@ -8,7 +8,7 @@ import ManagerDescription from "../../../concepts/structure/_manager_description
|
||||
<ManagerDescription name="ManagerDescription" />
|
||||
|
||||
To configure managers in ZITADEL go to the resource where you like to add it (e.g Instance, Organization, Project, GrantedProject).
|
||||
In the right part of the console you can find **MANAGERS** in the details part. Here you have a list of the current managers and can add a new one.
|
||||
In the right part of the management console you can find **MANAGERS** in the details part. Here you have a list of the current managers and can add a new one.
|
||||
|
||||
<img alt="Managers" src="/docs/img/guides/console/managers.png" width="200px" />
|
||||
|
||||
|
||||
@@ -33,7 +33,7 @@ For example, you could set up a project with roles that define access to your so
|
||||
|
||||
### Create a new organization
|
||||
|
||||
To create a new organization, click on the organizations dropdown in the Console and select **New organization**.
|
||||
To create a new organization, click on the organizations dropdown in the Management Console and select **New organization**.
|
||||
|
||||
You have two options regarding the initial administrator:
|
||||
1. **Current User:** Create the organization with your currently logged-in user as the organization manager. A membership for the new organization will be added to your account.
|
||||
|
||||
@@ -1,18 +1,18 @@
|
||||
---
|
||||
title: ZITADEL Console
|
||||
title: ZITADEL Management Console
|
||||
sidebar_label: Overview
|
||||
---
|
||||
|
||||
## What is console?
|
||||
## What is management console?
|
||||
|
||||
Console is the Dashboard UI for your instance. It can be accessed from all configured Custom Domains, defined in the Customer Portal.
|
||||
The console is used to configure global default settings and can be used by multiple Managers.
|
||||
Management Console is the Dashboard UI for your instance. It can be accessed from all configured Custom Domains, defined in the Customer Portal.
|
||||
The management console is used to configure global default settings and can be used by multiple Managers.
|
||||
Read more about [Console Managers](./managers) here.
|
||||
|
||||
It can also be used by your application users to modify their profile, although we recommend that you build your own User Interface.
|
||||
|
||||
When you are logged in, you are greeted by the home page. This page allows you to set shortcuts to settings and projects.
|
||||
The console has a context switcher on the **top-left** where your current organization is set.
|
||||
The management console has a context switcher on the **top-left** where your current organization is set.
|
||||
Depending on your use case, multiple organizations can be created (B2B) or you can stick to your global organization (B2C). To get an understanding of your use cases and how we recommend setting up your organizations, read the [Solution Scenario](../../solution-scenarios/introduction) guides.
|
||||
|
||||
<img
|
||||
@@ -21,9 +21,9 @@ Depending on your use case, multiple organizations can be created (B2B) or you c
|
||||
width="400px"
|
||||
/>
|
||||
|
||||
If your new to console, you'll probably want to set some settings initially. Continue reading Default settings on the next page.
|
||||
If your new to management console, you'll probably want to set some settings initially. Continue reading Default settings on the next page.
|
||||
|
||||
## Prevent console access
|
||||
## Prevent management console access
|
||||
|
||||
In some use cases you want to prevent users from accessing the ZITADEL management console.
|
||||
Please follow this [guide](/docs/guides/solution-scenarios/restrict-console) to achieve that.
|
||||
|
||||
@@ -31,7 +31,7 @@ Go to [Applications](./applications-overview) for more details.
|
||||
A role consists of different attributes, but only the **Key** is relevant to the authorization and must be unique within the project.
|
||||
* **Key:** The identifier used in code (e.g., `role.admin`).
|
||||
* **Display Name:** A human-readable name for the UI.
|
||||
* **Group:** Enables better handling in the ZITADEL console (e.g., giving a user all roles of a specific group).
|
||||
* **Group:** Enables better handling in the ZITADEL Management Console (e.g., giving a user all roles of a specific group).
|
||||
|
||||
Read more about managing roles [here](./roles).
|
||||
|
||||
|
||||
@@ -102,6 +102,6 @@ To access these roles in your application:
|
||||
|
||||
## References
|
||||
|
||||
- [Manage users in the Console](./users-overview#managing-users)
|
||||
- [Manage users in the Management Console](./users-overview#managing-users)
|
||||
- [Migrate to ZITADEL](/docs/guides/migrate/introduction)
|
||||
- [User onboarding and registration](/docs/guides/integrate/onboarding)
|
||||
@@ -68,6 +68,6 @@ If you only want to enable a subset of the supported languages, you can configur
|
||||
The login UI and notification messages are only rendered in one of the allowed languages and fallback to the instances default language.
|
||||
Also, the instances OIDC discovery endpoint will only list the allowed languages in the *ui_locales_supported* field.
|
||||
|
||||
All language settings are also configurable in the consoles *Languages* default settings.
|
||||
All language settings are also configurable in the management consoles *Languages* default settings.
|
||||
|
||||

|
||||
|
||||
@@ -14,7 +14,7 @@ When planning your applications, investing time in researching your apps archite
|
||||
This guide introduces you to the grouping and structuring of ZITADEL projects which forms the base for all projects. This can be used as a quick start to the [B2B scenario](./b2b), which is merely focused on planning considerations if you are having projects with multiple organizations.
|
||||
|
||||
The journey of this guide starts with creating an Organization, the outermost layer of ZITADEL within your instance, as it is the vessel for projects, roles, applications and users.
|
||||
Creation can be done from [ZITADEL Console](https://${CUSTOM_DOMAIN}.zitadel.cloud/ui/console/orgs/create). You can choose your current account for the organization owner or create a new one.
|
||||
Creation can be done from [ZITADEL Management Console](https://${CUSTOM_DOMAIN}.zitadel.cloud/ui/console/orgs/create). You can choose your current account for the organization owner or create a new one.
|
||||
|
||||
Depending on your Software Development Life Cycle (SDLC) you can create multiple organizations or projects to keep your applications environments separated.
|
||||
|
||||
@@ -77,10 +77,10 @@ In addition to visual modifications, you can edit notification texts for your us
|
||||
ZITADEL gives you handlebar similar templating for variables. Of course you can define texts for any language.
|
||||
We'd appreciate if you could contribute to our repo with translations of your language. Read on how to contribute [here](../manage/customize/texts).
|
||||
|
||||
> Note that your console design changes to your design too
|
||||
> Note that your management console design changes to your design too
|
||||
|
||||
</div>
|
||||
<img src="/docs/img/guides/branding.jpeg" alt="branding in console"/>
|
||||
<img src="/docs/img/guides/branding.jpeg" alt="branding in management console"/>
|
||||
</Column>
|
||||
|
||||
### Projects and applications
|
||||
|
||||
@@ -104,7 +104,7 @@ Go to the "Advanced" section, per default login with phone number should be allo
|
||||
|
||||
## Embedding ZITADEL in an iFrame
|
||||
|
||||
To maximize the security during login and in the Console UI, ZITADEL follows security best practices by setting a
|
||||
To maximize the security during login and in the Management Console UI, ZITADEL follows security best practices by setting a
|
||||
Content-Security-Policy (CSP), X-Frame-Options and cookies with SameSite Lax:
|
||||
|
||||
```
|
||||
|
||||
@@ -1,19 +1,19 @@
|
||||
---
|
||||
title: Prevent users from accessing ZITADEL console
|
||||
sidebar_label: Limit access to console
|
||||
title: Prevent users from accessing ZITADEL Management Console
|
||||
sidebar_label: Limit access to management console
|
||||
---
|
||||
|
||||
ZITADEL includes a console that allows Managers to configure all resources. All uses, including end-users, by default, view and manage their profile information.
|
||||
In some use cases you want to prevent users from accessing the console, this could be:
|
||||
ZITADEL includes a management console that allows Managers to configure all resources. All uses, including end-users, by default, view and manage their profile information.
|
||||
In some use cases you want to prevent users from accessing the management console, this could be:
|
||||
- User management is integrated into your own app
|
||||
- Users login via SSO and should not be able to change their data in the Console
|
||||
- Only managers should be able to access Console to manage their users
|
||||
- Users login via SSO and should not be able to change their data in the Management Console
|
||||
- Only managers should be able to access Management Console to manage their users
|
||||
|
||||
At the moment it is not possible to simply disable the Console, but with the configuration described in this guide, you can prevent users from accessing the Console.
|
||||
At the moment it is not possible to simply disable the Management Console, but with the configuration described in this guide, you can prevent users from accessing the Console.
|
||||
|
||||
## Self-hosted
|
||||
|
||||
If you are running ZITADEL self-hosted, we recommend restricting the access to ZITADEL Console via WAF/reverse-proxy for Non-Manager users
|
||||
If you are running ZITADEL self-hosted, we recommend restricting the access to ZITADEL Management Console via WAF/reverse-proxy for Non-Manager users
|
||||
|
||||
## ZITADEL Cloud (and self-hosted)
|
||||
|
||||
@@ -25,7 +25,7 @@ In that case you probably want to redirect the user to your own application, ins
|
||||
|
||||
Read more about how to set the default redirect URI: [Settings - Default Redirect URI](/docs/guides/manage/console/default-settings#default-redirect-uri)
|
||||
|
||||
### Restricting Console in default-project
|
||||
### Restricting Management Console in default-project
|
||||
|
||||
With this workaround, you will limit users from accessing the [default-project](/docs/guides/manage/console/projects-overview#the-default-project) if they are not explicitly granted to use this project.
|
||||
When setting the "Check for Project on Authentication" setting on a project, only users of organizations with a grant to that project can access it.
|
||||
@@ -33,7 +33,7 @@ By default, this setting is disabled, so all users can access the project.
|
||||
|
||||

|
||||
|
||||
Start by granting the organization of your managers, that should be able to access the Console, the [default project](/docs/guides/manage/console/projects-overview#the-default-project):
|
||||
Start by granting the organization of your managers, that should be able to access the Management Console, the [default project](/docs/guides/manage/console/projects-overview#the-default-project):
|
||||
|
||||
1. Click on the default-project > Grants > New +
|
||||

|
||||
@@ -44,7 +44,7 @@ Start by granting the organization of your managers, that should be able to acce
|
||||
3. You can skip the screen with the role selection and click save
|
||||
4. Make sure the grant is in now in the overview and marked as active.
|
||||
|
||||
To avoid accidental lock-out, the [default project](/docs/guides/manage/console/projects-overview#the-default-project) hides the checkbox "Check Project on Authentication" in the Console:
|
||||
To avoid accidental lock-out, the [default project](/docs/guides/manage/console/projects-overview#the-default-project) hides the checkbox "Check Project on Authentication" in the Management Console:
|
||||

|
||||
|
||||
You need to use the [update project API call](/docs/apis/resources/mgmt/management-service-update-project) to set the configuration on the project.
|
||||
@@ -73,7 +73,7 @@ curl -L -X PUT "https://${CUSTOM_DOMAIN}/management/v1/projects/${PROJECT_ID}" \
|
||||
Where
|
||||
- `${CUSTOM_DOMAIN}` is your Custom Domain, f.e. mydemo.zitadel.cloud
|
||||
- `${PAT}` is your service user's personal access token
|
||||
- `${PROJECT_ID}` is the default-project's ID that can be found in Console see screenshot above
|
||||
- `${PROJECT_ID}` is the default-project's ID that can be found in Management Console see screenshot above
|
||||
|
||||
You should now be able to log in with users of the organization that have the grant (in this example users of the organization "Customer-A").
|
||||
All other users should see the following error message after authentication:
|
||||
|
||||
@@ -31,7 +31,7 @@ Please [get in touch](https://zitadel.com/contact) with us to discuss your requi
|
||||
|
||||
## What rate limits do apply
|
||||
|
||||
For ZITADEL Cloud, we have dedicated rate limits for the user interfaces (login, register, console,...) and the APIs.
|
||||
For ZITADEL Cloud, we have dedicated rate limits for the user interfaces (login, register, management console,...) and the APIs.
|
||||
|
||||
Rate limits are implemented with the following rules:
|
||||
|
||||
|
||||
@@ -736,7 +736,7 @@ Our vision for AI is focused on two key areas: providing intelligent, contextual
|
||||
Our rollout is planned in phases to ensure we deliver a helpful experience:
|
||||
- **Phase 1 (Happening Now)**: We are currently testing a preliminary version of our AI bot within our [community channels](https://discord.com/channels/927474939156643850/1357076488825995477). This allows us to gather real-world questions and answers, refining the AI's accuracy and helpfulness based on direct feedback.
|
||||
- **Phase 2 (Next Steps)**: Once we are confident in its capabilities, we will integrate this AI assistant directly into our documentation. You'll be able to ask complex questions and get immediate, well-sourced answers.
|
||||
- **Phase 3 (The Ultimate Goal)**: The final step is to embed the assistant directly into the Zitadel Console/Customer Portal. Imagine getting help based on the exact context of what you're doing—whether you're configuring an action, setting up a new organization, or integrating social login.
|
||||
- **Phase 3 (The Ultimate Goal)**: The final step is to embed the assistant directly into the ZITADEL Management Console/Customer Portal. Imagine getting help based on the exact context of what you're doing—whether you're configuring an action, setting up a new organization, or integrating social login.
|
||||
|
||||
2. **Decentralized AI for Threat Detection**
|
||||
|
||||
|
||||
@@ -33,7 +33,7 @@ The example includes secure sign-out functionality implementing **[federated log
|
||||
|
||||
### Prerequisites
|
||||
|
||||
Before running this example, you need to create and configure a PKCE application in the [Zitadel Console](https://zitadel.com/docs/guides/manage/console/overview). Follow the PKCE application setup guide to:
|
||||
Before running this example, you need to create and configure a PKCE application in the [ZITADEL Management Console](https://zitadel.com/docs/guides/manage/console/overview). Follow the PKCE application setup guide to:
|
||||
|
||||
1. Create a new Web application in your [Zitadel project](https://zitadel.com/docs/guides/manage/console/projects)
|
||||
2. Configure it to use the PKCE authentication method
|
||||
@@ -42,7 +42,7 @@ Before running this example, you need to create and configure a PKCE application
|
||||
5. Copy your **Client ID** for use in the next steps
|
||||
6. Optionally enable [refresh tokens](https://zitadel.com/docs/apis/openidoauth/grant-types#refresh-token) in Token Settings for long-lived sessions
|
||||
|
||||
> **Note:** Make sure to enable **Dev Mode** in the [Zitadel Console](https://zitadel.com/docs/guides/manage/console/overview) if you're using HTTP URLs during local development. For production deployments, always use HTTPS URLs and disable Dev Mode.
|
||||
> **Note:** Make sure to enable **Dev Mode** in the [ZITADEL Management Console](https://zitadel.com/docs/guides/manage/console/overview) if you're using HTTP URLs during local development. For production deployments, always use HTTPS URLs and disable Dev Mode.
|
||||
|
||||
### Run the example
|
||||
|
||||
|
||||
@@ -33,7 +33,7 @@ The application includes complete [logout functionality](https://zitadel.com/doc
|
||||
|
||||
### Prerequisites
|
||||
|
||||
Before running this example, you need to create and configure a PKCE application in the [Zitadel Console](https://zitadel.com/docs/guides/manage/console/overview). Follow the PKCE application setup guide to:
|
||||
Before running this example, you need to create and configure a PKCE application in the [ZITADEL Management Console](https://zitadel.com/docs/guides/manage/console/overview). Follow the PKCE application setup guide to:
|
||||
|
||||
1. Create a new Web application in your [Zitadel project](https://zitadel.com/docs/guides/manage/console/projects)
|
||||
2. Configure it to use the PKCE authentication method
|
||||
@@ -41,7 +41,7 @@ Before running this example, you need to create and configure a PKCE application
|
||||
4. Configure post-logout redirect URIs (e.g., `http://localhost:4321/api/auth/logout/callback`)
|
||||
5. Copy your **Client ID** from the application details
|
||||
|
||||
> **Note:** Make sure to enable **Dev Mode** in the [Zitadel Console](https://zitadel.com/docs/guides/manage/console/overview) if you're using HTTP URLs during local development. For production deployments, always use HTTPS URLs and disable Dev Mode.
|
||||
> **Note:** Make sure to enable **Dev Mode** in the [ZITADEL Management Console](https://zitadel.com/docs/guides/manage/console/overview) if you're using HTTP URLs during local development. For production deployments, always use HTTPS URLs and disable Dev Mode.
|
||||
|
||||
### Run the example
|
||||
|
||||
|
||||
@@ -33,7 +33,7 @@ The application demonstrates proper **[federated logout](https://zitadel.com/doc
|
||||
|
||||
### Prerequisites
|
||||
|
||||
Before running this example, you need to create and configure a PKCE application in the [Zitadel Console](https://zitadel.com/docs/guides/manage/console/overview). Follow the PKCE application setup guide to:
|
||||
Before running this example, you need to create and configure a PKCE application in the [ZITADEL Management Console](https://zitadel.com/docs/guides/manage/console/overview). Follow the PKCE application setup guide to:
|
||||
|
||||
1. Create a new Web application in your [Zitadel project](https://zitadel.com/docs/guides/manage/console/projects)
|
||||
2. Configure it to use the PKCE authentication method
|
||||
@@ -42,7 +42,7 @@ Before running this example, you need to create and configure a PKCE application
|
||||
5. Copy your **Client ID** for use in the next steps
|
||||
6. Optionally enable [refresh tokens](https://zitadel.com/docs/apis/openidoauth/grant-types#refresh-token) in Token Settings for long-lived sessions
|
||||
|
||||
> **Note:** Make sure to enable **Dev Mode** in the [Zitadel Console](https://zitadel.com/docs/guides/manage/console/overview) if you're using HTTP URLs during local development. For production, always use HTTPS URLs and disable Dev Mode.
|
||||
> **Note:** Make sure to enable **Dev Mode** in the [ZITADEL Management Console](https://zitadel.com/docs/guides/manage/console/overview) if you're using HTTP URLs during local development. For production, always use HTTPS URLs and disable Dev Mode.
|
||||
|
||||
### Run the example
|
||||
|
||||
|
||||
@@ -33,7 +33,7 @@ Sign-out functionality implements **[federated logout](https://zitadel.com/docs/
|
||||
|
||||
### Prerequisites
|
||||
|
||||
Before running this example, you need to create and configure a PKCE application in the [Zitadel Console](https://zitadel.com/docs/guides/manage/console/overview). Follow the PKCE application setup guide to:
|
||||
Before running this example, you need to create and configure a PKCE application in the [ZITADEL Management Console](https://zitadel.com/docs/guides/manage/console/overview). Follow the PKCE application setup guide to:
|
||||
|
||||
1. Create a new Web application in your [Zitadel project](https://zitadel.com/docs/guides/manage/console/projects)
|
||||
2. Configure it to use the PKCE authentication method
|
||||
@@ -41,7 +41,7 @@ Before running this example, you need to create and configure a PKCE application
|
||||
4. Configure post-logout redirect URIs (e.g., `http://localhost:3000/auth/logout/callback`)
|
||||
5. Copy your **Client ID** for use in the next steps
|
||||
|
||||
> **Note:** Make sure to enable **Dev Mode** in the [Zitadel Console](https://zitadel.com/docs/guides/manage/console/overview) if you're using HTTP URLs during local development. For production, always use HTTPS URLs and disable Dev Mode.
|
||||
> **Note:** Make sure to enable **Dev Mode** in the [ZITADEL Management Console](https://zitadel.com/docs/guides/manage/console/overview) if you're using HTTP URLs during local development. For production, always use HTTPS URLs and disable Dev Mode.
|
||||
|
||||
### Run the example
|
||||
|
||||
|
||||
@@ -33,7 +33,7 @@ The application demonstrates proper **[federated logout](https://zitadel.com/doc
|
||||
|
||||
### Prerequisites
|
||||
|
||||
Before running this example, you need to create and configure a PKCE application in the [Zitadel Console](https://zitadel.com/docs/guides/manage/console/overview). Follow the PKCE application setup guide to:
|
||||
Before running this example, you need to create and configure a PKCE application in the [ZITADEL Management Console](https://zitadel.com/docs/guides/manage/console/overview). Follow the PKCE application setup guide to:
|
||||
|
||||
1. Create a new Web application in your [Zitadel project](https://zitadel.com/docs/guides/manage/console/projects)
|
||||
2. Configure it to use the PKCE authentication method
|
||||
@@ -42,7 +42,7 @@ Before running this example, you need to create and configure a PKCE application
|
||||
5. Copy your **Client ID** for use in the next steps
|
||||
6. Optionally enable [refresh tokens](https://zitadel.com/docs/apis/openidoauth/grant-types#refresh-token) in Token Settings for long-lived sessions
|
||||
|
||||
> **Note:** Make sure to enable **Dev Mode** in the [Zitadel Console](https://zitadel.com/docs/guides/manage/console/overview) if you're using HTTP URLs during local development. For production, always use HTTPS URLs and disable Dev Mode.
|
||||
> **Note:** Make sure to enable **Dev Mode** in the [ZITADEL Management Console](https://zitadel.com/docs/guides/manage/console/overview) if you're using HTTP URLs during local development. For production, always use HTTPS URLs and disable Dev Mode.
|
||||
|
||||
### Run the example
|
||||
|
||||
|
||||
@@ -33,7 +33,7 @@ The application also demonstrates proper **[federated logout](https://zitadel.co
|
||||
|
||||
### Prerequisites
|
||||
|
||||
Before running this example, you need to create and configure a PKCE application in the [Zitadel Console](https://zitadel.com/docs/guides/manage/console/overview). Follow the PKCE application setup guide to:
|
||||
Before running this example, you need to create and configure a PKCE application in the [ZITADEL Management Console](https://zitadel.com/docs/guides/manage/console/overview). Follow the PKCE application setup guide to:
|
||||
|
||||
1. Create a new Web application in your [Zitadel project](https://zitadel.com/docs/guides/manage/console/projects)
|
||||
2. Configure it to use the PKCE authentication method
|
||||
@@ -42,7 +42,7 @@ Before running this example, you need to create and configure a PKCE application
|
||||
5. Copy your **Client ID** for use in the next steps
|
||||
6. Optionally enable [refresh tokens](https://zitadel.com/docs/apis/openidoauth/grant-types#refresh-token) in Token Settings for long-lived sessions
|
||||
|
||||
> **Note:** Make sure to enable **Dev Mode** in the [Zitadel Console](https://zitadel.com/docs/guides/manage/console/overview) if you're using HTTP URLs during local development. For production, always use HTTPS URLs and disable Dev Mode.
|
||||
> **Note:** Make sure to enable **Dev Mode** in the [ZITADEL Management Console](https://zitadel.com/docs/guides/manage/console/overview) if you're using HTTP URLs during local development. For production, always use HTTPS URLs and disable Dev Mode.
|
||||
|
||||
### Run the example
|
||||
|
||||
|
||||
@@ -33,7 +33,7 @@ The application demonstrates proper **[federated logout](https://zitadel.com/doc
|
||||
|
||||
### Prerequisites
|
||||
|
||||
Before running this example, you need to create and configure a PKCE application in the [Zitadel Console](https://zitadel.com/docs/guides/manage/console/overview). Follow the PKCE application setup guide to:
|
||||
Before running this example, you need to create and configure a PKCE application in the [ZITADEL Management Console](https://zitadel.com/docs/guides/manage/console/overview). Follow the PKCE application setup guide to:
|
||||
|
||||
1. Create a new Web application in your [Zitadel project](https://zitadel.com/docs/guides/manage/console/projects)
|
||||
2. Configure it to use the PKCE authentication method
|
||||
@@ -42,7 +42,7 @@ Before running this example, you need to create and configure a PKCE application
|
||||
5. Copy your **Client ID** for use in the next steps
|
||||
6. Optionally enable [refresh tokens](https://zitadel.com/docs/apis/openidoauth/grant-types#refresh-token) in Token Settings for long-lived sessions
|
||||
|
||||
> **Note:** Make sure to enable **Dev Mode** in the [Zitadel Console](https://zitadel.com/docs/guides/manage/console/overview) if you're using HTTP URLs during local development. For production, always use HTTPS URLs and disable Dev Mode.
|
||||
> **Note:** Make sure to enable **Dev Mode** in the [ZITADEL Management Console](https://zitadel.com/docs/guides/manage/console/overview) if you're using HTTP URLs during local development. For production, always use HTTPS URLs and disable Dev Mode.
|
||||
|
||||
### Run the example
|
||||
|
||||
|
||||
@@ -31,7 +31,7 @@ The implementation uses [Handlebars templates](https://handlebarsjs.com/) for se
|
||||
|
||||
### Prerequisites
|
||||
|
||||
Before running this example, you need to create and configure a PKCE application in the [Zitadel Console](https://zitadel.com/docs/guides/manage/console/overview). Follow the PKCE application setup guide to:
|
||||
Before running this example, you need to create and configure a PKCE application in the [ZITADEL Management Console](https://zitadel.com/docs/guides/manage/console/overview). Follow the PKCE application setup guide to:
|
||||
|
||||
1. Create a new Web application in your [Zitadel project](https://zitadel.com/docs/guides/manage/console/projects)
|
||||
2. Configure it to use the PKCE authentication method
|
||||
@@ -39,7 +39,7 @@ Before running this example, you need to create and configure a PKCE application
|
||||
4. Configure post-logout redirect URIs (e.g., `http://localhost:3000/auth/logout/callback`)
|
||||
5. Copy your **Client ID** for use in the next steps
|
||||
|
||||
> **Note:** Make sure to enable **Dev Mode** in the [Zitadel Console](https://zitadel.com/docs/guides/manage/console/overview) if you're using HTTP URLs during local development. For production, always use HTTPS URLs and disable Dev Mode.
|
||||
> **Note:** Make sure to enable **Dev Mode** in the [ZITADEL Management Console](https://zitadel.com/docs/guides/manage/console/overview) if you're using HTTP URLs during local development. For production, always use HTTPS URLs and disable Dev Mode.
|
||||
|
||||
### Run the example
|
||||
|
||||
|
||||
@@ -31,7 +31,7 @@ import { Frameworks } from "../../src/components/frameworks";
|
||||
|
||||
<Frameworks filter={(framework) => framework.client === false || framework.client == null} />
|
||||
|
||||
To further streamline your setup, simply visit the console in Zitadel where you can select one of the languages or frameworks. This will allow you to instantly set up the configuration for that specific sample in Zitadel, ensuring you have everything you need to get started right away.
|
||||
To further streamline your setup, simply visit the management console in Zitadel where you can select one of the languages or frameworks. This will allow you to instantly set up the configuration for that specific sample in Zitadel, ensuring you have everything you need to get started right away.
|
||||
|
||||

|
||||
|
||||
|
||||
@@ -33,7 +33,7 @@ The application demonstrates proper **[federated logout](https://zitadel.com/doc
|
||||
|
||||
### Prerequisites
|
||||
|
||||
Before running this example, you need to create and configure a PKCE application in the [Zitadel Console](https://zitadel.com/docs/guides/manage/console/overview). Follow the PKCE application setup guide to:
|
||||
Before running this example, you need to create and configure a PKCE application in the [ZITADEL Management Console](https://zitadel.com/docs/guides/manage/console/overview). Follow the PKCE application setup guide to:
|
||||
|
||||
1. Create a new Web application in your [Zitadel project](https://zitadel.com/docs/guides/manage/console/projects)
|
||||
2. Configure it to use the PKCE authentication method
|
||||
@@ -42,7 +42,7 @@ Before running this example, you need to create and configure a PKCE application
|
||||
5. Copy your **Client ID** for use in the next steps
|
||||
6. Optionally enable [refresh tokens](https://zitadel.com/docs/apis/openidoauth/grant-types#refresh-token) in Token Settings for long-lived sessions
|
||||
|
||||
> **Note:** Make sure to enable **Dev Mode** in the [Zitadel Console](https://zitadel.com/docs/guides/manage/console/overview) if you're using HTTP URLs during local development. For production, always use HTTPS URLs and disable Dev Mode.
|
||||
> **Note:** Make sure to enable **Dev Mode** in the [ZITADEL Management Console](https://zitadel.com/docs/guides/manage/console/overview) if you're using HTTP URLs during local development. For production, always use HTTPS URLs and disable Dev Mode.
|
||||
|
||||
### Run the example
|
||||
|
||||
|
||||
@@ -35,7 +35,7 @@ All protected routes are secured using the [@mridang/nestjs-auth global guard](h
|
||||
|
||||
### Prerequisites
|
||||
|
||||
Before running this example, you need to create and configure a PKCE application in the [Zitadel Console](https://zitadel.com/docs/guides/manage/console/overview). Follow the PKCE application setup guide to:
|
||||
Before running this example, you need to create and configure a PKCE application in the [ZITADEL Management Console](https://zitadel.com/docs/guides/manage/console/overview). Follow the PKCE application setup guide to:
|
||||
|
||||
1. Create a new Web application in your [Zitadel project](https://zitadel.com/docs/guides/manage/console/projects)
|
||||
2. Configure it to use the PKCE authentication method
|
||||
@@ -43,7 +43,7 @@ Before running this example, you need to create and configure a PKCE application
|
||||
4. Configure post-logout redirect URIs (e.g., `http://localhost:3000/auth/logout/callback`)
|
||||
5. Copy your **Client ID** for use in the next steps
|
||||
|
||||
> **Note:** Make sure to enable **Dev Mode** in the [Zitadel Console](https://zitadel.com/docs/guides/manage/console/overview) if you're using HTTP URLs during local development. For production, always use HTTPS URLs and disable Dev Mode.
|
||||
> **Note:** Make sure to enable **Dev Mode** in the [ZITADEL Management Console](https://zitadel.com/docs/guides/manage/console/overview) if you're using HTTP URLs during local development. For production, always use HTTPS URLs and disable Dev Mode.
|
||||
|
||||
### Run the example
|
||||
|
||||
|
||||
@@ -33,7 +33,7 @@ The logout flow implements **[federated logout](https://zitadel.com/docs/guides/
|
||||
|
||||
### Prerequisites
|
||||
|
||||
Before running this example, you need to create and configure a PKCE application in the [Zitadel Console](https://zitadel.com/docs/guides/manage/console/overview). Follow the PKCE application setup guide to:
|
||||
Before running this example, you need to create and configure a PKCE application in the [ZITADEL Management Console](https://zitadel.com/docs/guides/manage/console/overview). Follow the PKCE application setup guide to:
|
||||
|
||||
1. Create a new Web application in your [Zitadel project](https://zitadel.com/docs/guides/manage/console/projects)
|
||||
2. Configure it to use the PKCE authentication method
|
||||
@@ -42,7 +42,7 @@ Before running this example, you need to create and configure a PKCE application
|
||||
5. Copy your **Client ID** for use in the next steps
|
||||
6. Optionally enable [refresh tokens](https://zitadel.com/docs/apis/openidoauth/grant-types#refresh-token) in Token Settings for long-lived sessions
|
||||
|
||||
> **Note:** Make sure to enable **Dev Mode** in the [Zitadel Console](https://zitadel.com/docs/guides/manage/console/overview) if you're using HTTP URLs during local development. For production deployments, always use HTTPS URLs and disable Dev Mode.
|
||||
> **Note:** Make sure to enable **Dev Mode** in the [ZITADEL Management Console](https://zitadel.com/docs/guides/manage/console/overview) if you're using HTTP URLs during local development. For production deployments, always use HTTPS URLs and disable Dev Mode.
|
||||
|
||||
### Run the example
|
||||
|
||||
|
||||
@@ -31,7 +31,7 @@ The example implements secure [session management](https://authjs.dev/concepts/s
|
||||
|
||||
### Prerequisites
|
||||
|
||||
Before running this example, you need to create and configure a PKCE application in the [Zitadel Console](https://zitadel.com/docs/guides/manage/console/overview). Follow the PKCE application setup guide to:
|
||||
Before running this example, you need to create and configure a PKCE application in the [ZITADEL Management Console](https://zitadel.com/docs/guides/manage/console/overview). Follow the PKCE application setup guide to:
|
||||
|
||||
1. Create a new Web application in your [Zitadel project](https://zitadel.com/docs/guides/manage/console/projects)
|
||||
2. Configure it to use the PKCE authentication method
|
||||
@@ -39,7 +39,7 @@ Before running this example, you need to create and configure a PKCE application
|
||||
4. Configure post-logout redirect URIs (e.g., `http://localhost:3000/`)
|
||||
5. Copy your **Client ID** for use in the next steps
|
||||
|
||||
> **Note:** Make sure to enable **Dev Mode** in the Zitadel Console if you're using HTTP URLs during local development. For production, always use HTTPS URLs and disable Dev Mode.
|
||||
> **Note:** Make sure to enable **Dev Mode** in the ZITADEL Management Console if you're using HTTP URLs during local development. For production, always use HTTPS URLs and disable Dev Mode.
|
||||
|
||||
### Run the example
|
||||
|
||||
|
||||
@@ -33,7 +33,7 @@ Sign-out functionality implements **[federated logout](https://zitadel.com/docs/
|
||||
|
||||
### Prerequisites
|
||||
|
||||
Before running this example, you need to create and configure a PKCE application in the [Zitadel Console](https://zitadel.com/docs/guides/manage/console/overview). Follow the PKCE application setup guide to:
|
||||
Before running this example, you need to create and configure a PKCE application in the [ZITADEL Management Console](https://zitadel.com/docs/guides/manage/console/overview). Follow the PKCE application setup guide to:
|
||||
|
||||
1. Create a new Web application in your [Zitadel project](https://zitadel.com/docs/guides/manage/console/projects)
|
||||
2. Configure it to use the PKCE authentication method
|
||||
@@ -41,7 +41,7 @@ Before running this example, you need to create and configure a PKCE application
|
||||
4. Configure post-logout redirect URIs (e.g., `http://localhost:3000/api/auth/logout/callback`)
|
||||
5. Copy your **Client ID** for use in the next steps
|
||||
|
||||
> **Note:** Make sure to enable **Dev Mode** in the [Zitadel Console](https://zitadel.com/docs/guides/manage/console/overview) if you're using HTTP URLs during local development. For production, always use HTTPS URLs and disable Dev Mode.
|
||||
> **Note:** Make sure to enable **Dev Mode** in the [ZITADEL Management Console](https://zitadel.com/docs/guides/manage/console/overview) if you're using HTTP URLs during local development. For production, always use HTTPS URLs and disable Dev Mode.
|
||||
|
||||
### Run the example
|
||||
|
||||
|
||||
@@ -33,7 +33,7 @@ The example leverages [React Router](https://reactrouter.com) for client-side na
|
||||
|
||||
### Prerequisites
|
||||
|
||||
Before running this example, you need to create and configure a PKCE application in the [Zitadel Console](https://zitadel.com/docs/guides/manage/console/overview). Follow the PKCE application setup guide to:
|
||||
Before running this example, you need to create and configure a PKCE application in the [ZITADEL Management Console](https://zitadel.com/docs/guides/manage/console/overview). Follow the PKCE application setup guide to:
|
||||
|
||||
1. Create a new Web application in your [Zitadel project](https://zitadel.com/docs/guides/manage/console/projects)
|
||||
2. Configure it to use the PKCE authentication method
|
||||
@@ -41,7 +41,7 @@ Before running this example, you need to create and configure a PKCE application
|
||||
4. Configure post-logout redirect URIs (e.g., `http://localhost:3000/`)
|
||||
5. Copy your **Client ID** for use in the next steps
|
||||
|
||||
> **Note:** Make sure to enable **Dev Mode** in the [Zitadel Console](https://zitadel.com/docs/guides/manage/console/overview) if you're using HTTP URLs during local development. For production, always use HTTPS URLs and disable Dev Mode.
|
||||
> **Note:** Make sure to enable **Dev Mode** in the [ZITADEL Management Console](https://zitadel.com/docs/guides/manage/console/overview) if you're using HTTP URLs during local development. For production, always use HTTPS URLs and disable Dev Mode.
|
||||
|
||||
### Run the example
|
||||
|
||||
|
||||
@@ -31,7 +31,7 @@ The application implements automatic [token refresh](https://zitadel.com/docs/ap
|
||||
|
||||
### Prerequisites
|
||||
|
||||
Before running this example, you need to create and configure a PKCE application in the [Zitadel Console](https://zitadel.com/docs/guides/manage/console/overview). Follow the PKCE application setup guide to:
|
||||
Before running this example, you need to create and configure a PKCE application in the [ZITADEL Management Console](https://zitadel.com/docs/guides/manage/console/overview). Follow the PKCE application setup guide to:
|
||||
|
||||
1. Create a new Web application in your [Zitadel project](https://zitadel.com/docs/guides/manage/console/projects)
|
||||
2. Configure it to use the PKCE authentication method
|
||||
@@ -39,7 +39,7 @@ Before running this example, you need to create and configure a PKCE application
|
||||
4. Configure post-logout redirect URIs (e.g., `http://localhost:3000/api/auth/logout/callback`)
|
||||
5. Copy your **Client ID** for use in the next steps
|
||||
|
||||
> **Note:** Make sure to enable **Dev Mode** in the [Zitadel Console](https://zitadel.com/docs/guides/manage/console/overview) if you're using HTTP URLs during local development. For production, always use HTTPS URLs and disable Dev Mode.
|
||||
> **Note:** Make sure to enable **Dev Mode** in the [ZITADEL Management Console](https://zitadel.com/docs/guides/manage/console/overview) if you're using HTTP URLs during local development. For production, always use HTTPS URLs and disable Dev Mode.
|
||||
|
||||
### Run the example
|
||||
|
||||
|
||||
@@ -33,7 +33,7 @@ The logout flow implements **[federated logout](https://zitadel.com/docs/guides/
|
||||
|
||||
### Prerequisites
|
||||
|
||||
Before running this example, you need to create and configure a PKCE application in the [Zitadel Console](https://zitadel.com/docs/guides/manage/console/overview). Follow the PKCE application setup guide to:
|
||||
Before running this example, you need to create and configure a PKCE application in the [ZITADEL Management Console](https://zitadel.com/docs/guides/manage/console/overview). Follow the PKCE application setup guide to:
|
||||
|
||||
1. Create a new Web application in your [Zitadel project](https://zitadel.com/docs/guides/manage/console/projects)
|
||||
2. Configure it to use the PKCE authentication method
|
||||
@@ -41,7 +41,7 @@ Before running this example, you need to create and configure a PKCE application
|
||||
4. Configure post-logout redirect URIs (e.g., `http://localhost:3000/auth/logout/callback`)
|
||||
5. Copy your **Client ID** for use in the next steps
|
||||
|
||||
> **Note:** Make sure to enable **Dev Mode** in the [Zitadel Console](https://zitadel.com/docs/guides/manage/console/overview) if you're using HTTP URLs during local development. For production, always use HTTPS URLs and disable Dev Mode.
|
||||
> **Note:** Make sure to enable **Dev Mode** in the [ZITADEL Management Console](https://zitadel.com/docs/guides/manage/console/overview) if you're using HTTP URLs during local development. For production, always use HTTPS URLs and disable Dev Mode.
|
||||
|
||||
### Run the example
|
||||
|
||||
|
||||
@@ -33,7 +33,7 @@ The application demonstrates proper **[federated logout](https://zitadel.com/doc
|
||||
|
||||
### Prerequisites
|
||||
|
||||
Before running this example, you need to create and configure a PKCE application in the [Zitadel Console](https://zitadel.com/docs/guides/manage/console/overview). Follow the PKCE application setup guide to:
|
||||
Before running this example, you need to create and configure a PKCE application in the [ZITADEL Management Console](https://zitadel.com/docs/guides/manage/console/overview). Follow the PKCE application setup guide to:
|
||||
|
||||
1. Create a new Web application in your [Zitadel project](https://zitadel.com/docs/guides/manage/console/projects)
|
||||
2. Configure it to use the PKCE authentication method
|
||||
@@ -42,7 +42,7 @@ Before running this example, you need to create and configure a PKCE application
|
||||
5. Copy your **Client ID** for use in the next steps
|
||||
6. Optionally enable [refresh tokens](https://zitadel.com/docs/apis/openidoauth/grant-types#refresh-token) in Token Settings for long-lived sessions
|
||||
|
||||
> **Note:** Make sure to enable **Dev Mode** in the [Zitadel Console](https://zitadel.com/docs/guides/manage/console/overview) if you're using HTTP URLs during local development. For production, always use HTTPS URLs and disable Dev Mode.
|
||||
> **Note:** Make sure to enable **Dev Mode** in the [ZITADEL Management Console](https://zitadel.com/docs/guides/manage/console/overview) if you're using HTTP URLs during local development. For production, always use HTTPS URLs and disable Dev Mode.
|
||||
|
||||
### Run the example
|
||||
|
||||
|
||||
@@ -33,7 +33,7 @@ The example includes secure sign-out functionality implementing **[federated log
|
||||
|
||||
### Prerequisites
|
||||
|
||||
Before running this example, you need to create and configure a PKCE application in the [Zitadel Console](https://zitadel.com/docs/guides/manage/console/overview). Follow the PKCE application setup guide to:
|
||||
Before running this example, you need to create and configure a PKCE application in the [ZITADEL Management Console](https://zitadel.com/docs/guides/manage/console/overview). Follow the PKCE application setup guide to:
|
||||
|
||||
1. Create a new Web application in your [Zitadel project](https://zitadel.com/docs/guides/manage/console/projects)
|
||||
2. Configure it to use the PKCE authentication method
|
||||
@@ -41,7 +41,7 @@ Before running this example, you need to create and configure a PKCE application
|
||||
4. Configure post-logout redirect URIs
|
||||
5. Copy your **Client ID** for use in the next steps
|
||||
|
||||
> **Note:** Make sure to enable **Dev Mode** in the [Zitadel Console](https://zitadel.com/docs/guides/manage/console/overview) if you're using HTTP URLs during local development. For production, always use HTTPS URLs and disable Dev Mode.
|
||||
> **Note:** Make sure to enable **Dev Mode** in the [ZITADEL Management Console](https://zitadel.com/docs/guides/manage/console/overview) if you're using HTTP URLs during local development. For production, always use HTTPS URLs and disable Dev Mode.
|
||||
|
||||
### Run the example
|
||||
|
||||
|
||||
@@ -30,4 +30,4 @@ cd zitadel
|
||||
|
||||
## Using Dev Container
|
||||
|
||||
Once the container is running, you will have a development environment set up with all the necessary dependencies pre-installed. You can then follow the instructions in the ZITADEL [contribution guide](https://github.com/zitadel/zitadel/blob/main/CONTRIBUTING.md#developing-zitadel-with-dev-containers) to build and run ZITADEL, or develop the ZITADEL console application.
|
||||
Once the container is running, you will have a development environment set up with all the necessary dependencies pre-installed. You can then follow the instructions in the ZITADEL [contribution guide](https://github.com/zitadel/zitadel/blob/main/CONTRIBUTING.md#developing-zitadel-with-dev-containers) to build and run ZITADEL, or develop the ZITADEL Management Console application.
|
||||
|
||||
@@ -175,7 +175,7 @@ Milestones are used to track the administrator's progress in setting up their in
|
||||
Milestones are reached upon the first time a certain action is performed. For example the first application created or the first human login. In order to push a "reached" event only once, ZITADEL must keep track of the current state of milestones by an eventstore query every time an eligible action is performed. This can cause an unwanted overhead on production servers, therefore they are cached.
|
||||
|
||||
As an extra optimization, once all milestones are reached by the instance, an in-memory flag is set and the milestone state is never queried again from the database nor cache.
|
||||
For single instance setups which fulfilled all milestone (*your next steps* in console) it is not needed to enable this cache. We mainly use it for ZITADEL cloud where there are many instances with *incomplete* milestones.
|
||||
For single instance setups which fulfilled all milestone (*your next steps* in the management console) it is not needed to enable this cache. We mainly use it for ZITADEL cloud where there are many instances with *incomplete* milestones.
|
||||
|
||||
### Organization
|
||||
|
||||
|
||||
@@ -56,7 +56,7 @@ Be aware that you won't automatically have the organizations context when you ac
|
||||
## Generated Subdomains
|
||||
|
||||
ZITADEL creates random subdomains for [each new virtual instance](/concepts/structure/instance#multiple-virtual-instances).
|
||||
You can immediately access the ZITADEL Console and APIs using these subdomains without further actions.
|
||||
You can immediately access the ZITADEL Management Console and APIs using these subdomains without further actions.
|
||||
|
||||
## More Information
|
||||
|
||||
|
||||
@@ -43,5 +43,5 @@ Enter the base URI of your Login UI, for example `http://localhost:3000/ui/v2/lo
|
||||
# Test
|
||||
|
||||
That's it!
|
||||
Click your users avatar in the top right corner of the console and select `Log in With Another Account`.
|
||||
Click your users avatar in the top right corner of the management console and select `Log in With Another Account`.
|
||||
You should see the new Login UI.
|
||||
|
||||
@@ -32,7 +32,7 @@ Also, not all configuration options are available as environment variables.
|
||||
- To enable and restrict access to **HTTPS**, head over to [the description of your TLS options](/docs/self-hosting/manage/tls_modes).
|
||||
- If you want to front ZITADEL with a reverse proxy, web application firewall or content delivery network, make sure to support **[HTTP/2](/docs/self-hosting/manage/http2)**.
|
||||
- You can also refer to some **[example reverse proxy configurations](/docs/self-hosting/manage/reverseproxy/reverse_proxy)**.
|
||||
- The ZITADEL Console web GUI uses many gRPC-Web stubs. This results in a fairly big JavaScript bundle. You might want to compress it using [Gzip](https://www.gnu.org/software/gzip/) or [Brotli](https://github.com/google/brotli).
|
||||
- The ZITADEL Management Console web GUI uses many gRPC-Web stubs. This results in a fairly big JavaScript bundle. You might want to compress it using [Gzip](https://www.gnu.org/software/gzip/) or [Brotli](https://github.com/google/brotli).
|
||||
- Serving and caching the assets using a content delivery network could improve network latencies and shield your ZITADEL runtime.
|
||||
|
||||
## Monitoring
|
||||
|
||||
@@ -82,7 +82,7 @@ export const LoginURL = ({mode}) => {
|
||||
- **username**: *zitadel-admin@<span></span>zitadel.127.0.0.1.sslip.io*
|
||||
- **password**: *Password1!*
|
||||
|
||||
If the console loads normally, you know that the HTTP and gRPC-Web and gRPC APIs are working correctly.
|
||||
If the management console loads normally, you know that the HTTP and gRPC-Web and gRPC APIs are working correctly.
|
||||
|
||||
<CodeBlock language="bash">
|
||||
{'# You can now stop the database, the Zitadel API, the Zitadel login and '}{props.providername}{'.'}{'\n'}
|
||||
|
||||
@@ -129,7 +129,7 @@ DefaultInstance:
|
||||
|
||||
If a quota is configured to limit requests and the quotas amount is exhausted, all further authenticated requests are blocked except requests to the [system API](/apis/introduction#system).
|
||||
Also, a cookie is set, to make it easier to block further traffic before it reaches your ZITADEL runtime, for example with a WAF rule.
|
||||
The console is still served, but it only shows a dialog that says that the instance is blocked with a link to *InstanceManagementURL*.
|
||||
The management console is still served, but it only shows a dialog that says that the instance is blocked with a link to *InstanceManagementURL*.
|
||||
|
||||
### Exhausted Action Run Seconds
|
||||
|
||||
|
||||
@@ -13,7 +13,7 @@ Date: Calendar week 44
|
||||
Since Angular Material v15 many of the UI components have been refactored
|
||||
to be based on the official Material Design Components for Web (MDC).
|
||||
These refactored components do not support dynamic styling, so in order to keep the library up-to-date,
|
||||
the console UI will lose its dynamic theming capability.
|
||||
the management console UI will lose its dynamic theming capability.
|
||||
|
||||
## Statement
|
||||
|
||||
@@ -24,11 +24,11 @@ As soon as the release version is published, we will include the version here.
|
||||
|
||||
If you need users to have your branding settings
|
||||
(background-, button-, link and text coloring), you should implement your
|
||||
own user facing UI yourself and not use ZITADELs console UI. Assets like your logo and icons will still be used.
|
||||
own user facing UI yourself and not use ZITADELs management console UI. Assets like your logo and icons will still be used.
|
||||
|
||||
## Impact
|
||||
|
||||
Once this update has been released and deployed, the console UI won't apply any coloring of your branding settings to the UI components.
|
||||
Once this update has been released and deployed, the management console UI won't apply any coloring of your branding settings to the UI components.
|
||||
|
||||
:::note
|
||||
ZITADEL hosted Login-UI is not affected by this change.
|
||||
|
||||
@@ -61,10 +61,10 @@ We understand that these advisories may include breaking changes, and we aim to
|
||||
Since Angular Material v15 many of the UI components have been refactored
|
||||
to be based on the official Material Design Components for Web (MDC).
|
||||
These refactored components do not support dynamic styling, so in order to
|
||||
keep the library up-to-date, the console UI will loose its dynamic theming
|
||||
keep the library up-to-date, the management console UI will loose its dynamic theming
|
||||
capability. If you need users to have your branding settings (background-,
|
||||
button-, link and text coloring) you should implement your own user
|
||||
facing UI yourself and not use ZITADELs console UI.
|
||||
facing UI yourself and not use ZITADELs management console UI.
|
||||
ZITADEL hosted Login-UI is not affected by this change.
|
||||
</td>
|
||||
<td>2.40.0</td>
|
||||
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user