mirror of
https://github.com/andwati/zitadel.git
synced 2026-11-04 05:12:16 +00:00
93a4ed8857
# Which Problems Are Solved As part of the naming consistency initiative, the terms Authorization, User grants, internal authorization and other similar terms that are used in the context of assigning project roles to users are replaced by Role Assignments in the UI, API docs, and documentation. # How the Problems Are Solved By replacing the following terms with Role Assignments in API docs, Console UI, and guides. - Authorization - internal authorization - external authorization - User Grant - Roles and Authorizations By adding a note in the API docs to make it clear that Authorization within the context of Authorization Service API refers to role assignments, not to OAuth authorization as it is still used in the APIs. By updating some screenshots in documentation / guides to show "Role Assignments" instead of "Authorizations" in the UI. # Additional Changes N/A # Additional Context - Closes https://github.com/zitadel/zitadel/issues/11289 --------- Co-authored-by: Copilot <[email protected]>
54 lines
2.4 KiB
Plaintext
54 lines
2.4 KiB
Plaintext
---
|
|
title: ZITADEL Roles and Role Assignments
|
|
sidebar_label: Roles and Role Assignments
|
|
---
|
|
|
|
If you built out the [POS use case example](./projects-overview#example-scenario), you would probably need an application for administration.
|
|
In this application you would probably have somebody accessing as an accountant and somebody as an administrator, who is somebody with enhanced rights.
|
|
To achieve this, you would have to add this distinction as roles.
|
|
To add roles, jump to the section **Roles** and create those new roles with the following values
|
|
|
|
- Key: admin
|
|
- Display Name: Administrator
|
|
- Group: Administration
|
|
|
|
and
|
|
|
|
- Key: account
|
|
- Display Name: Accountant
|
|
- Group: Administration
|
|
|
|
<img src="/docs/img/guides/console/addrole.png" alt="Add roles" />
|
|
|
|
The **Key** is used for coding (can then, for example, be requested in the ID Token).
|
|
|
|
The **Display Name** is just for you to remember its use case
|
|
|
|
The **Group** is to make it easier to assign multiple roles at once.
|
|
|
|
<img src="/docs/img/guides/console/roles.png" width="750px" alt="Roles" />
|
|
|
|
> The role client is for another application of the project `POS`, as all possible roles from your POS applications are defined in your project.
|
|
|
|
## Role Assignments
|
|
|
|
Now, to make use of these roles, add a role assignment.
|
|
A role assignment combines a user of your organization with one or multiple roles.
|
|
|
|
> You can also add users of other organizations. Click on the hint below the username field to create an [external user role assignment](/concepts/features/external-user-grant).
|
|
|
|
<img src="/docs/img/guides/console/authusers.png" width="500px" alt="Auth users" />
|
|
|
|
If you want to test your application with your own user, navigate to the **Role Assignments** section under your project and click on **new**.
|
|
|
|
Type your username, hit "Continue," select the roles you want your user to have, and save. If you want to add all roles of the Administration group, you can click on the group to select all.
|
|
|
|
<img
|
|
src="/docs/img/guides/console/authorization.png"
|
|
width="750px"
|
|
alt="RoleAssignments"
|
|
/>
|
|
|
|
Now you can retrieve those roles in your application. ZITADEL has [multiple settings](./projects-overview#project-settings) for you to access them more easily. Navigate to the **General** section of your project for more settings.
|
|
|
|
> Note: We set up the role assignments from projects, but this can be achieved from multiple locations in the console. You can view and assign roles from the organization, the projects, or from the users page. |