andwati/zitadel
1
0
Fork 0
mirror of https://github.com/andwati/zitadel.git synced 2026-10-24 00:02:15 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: add clarification for user roles membership (#11359)

Browse Source 
This PR add some clarification to determine which roles are assigned to
a user using either introspection or claims added to the token
This commit is contained in:
Federico Coppede
2026-01-14 16:15:28 +01:00
committed by GitHub
parent dc01a0abff
commit 2797a0bb03
1 changed files with 8 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/docs/guides/integrate/retrieve-user-roles.md
+8
View File
@@ -81,6 +81,14 @@ If you need them included in your ID Token, select **’User Roles Inside ID Tok
Alternatively, you can include the claims `urn:iam:org:project:roles` or/and `urn:zitadel:iam:org:projects:roles` in your scope to achieve the same as above.
### Determine the roles assigned to a user
To determine the roles assigned to a user, you have two options:
- **Token claims**: Request that the relevant roles claim (such as `urn:zitadel:iam:org:project:{projectId}:roles`) is included in the token when you authenticate. The roles assigned to the user will then be part of the token’s payload.
- **Token introspection**: After a token is issued, you can introspect it using the [ZITADEL introspection endpoint](/docs/guides/integrate/token-introspection) to view the roles claim. This will return the roles assigned to the user according to the token.
### Retrieve roles from the userinfo endpoint
The user info endpoint is **`${CUSTOM_DOMAIN}`/oidc/v1/userinfo**.