keycloak-scim/server_admin/topics/roles/composite.adoc

24 lines
1.1 KiB
Text
Raw Normal View History

2016-05-25 15:08:14 +00:00
[[_composite-roles]]
=== Composite Roles
Any realm or client level role can be a _composite role_. A _composite role_ is a role that has one or more additional roles associated with it. When a composite role is mapped to a user, the user also gains the roles associated with that composite. This inheritance is recursive so users also inherit any composite of composites. However, we recommend that composite roles are not overused.
2016-05-25 15:08:14 +00:00
To convert a role to a composite role:
. Click `Roles` in the left menu.
. Click the role to access the roles detail page.
. Set `Composite Roles` to ON.
2016-05-25 15:08:14 +00:00
.Composite Role
2017-08-28 12:50:14 +00:00
image:{project_images}/composite-role.png[]
2016-05-25 15:08:14 +00:00
The role selection UI is displayed on the page and you can associate realm level and client level roles to the composite role you are creating.
In this example, the `employee` realm-level role is associated with the `developer` composite role. Any user with the `developer` role also inherits the `employee` role.
2016-05-25 15:08:14 +00:00
[NOTE]
====
When creating tokens and SAML assertions, any composite also has its associated roles added to the claims and assertions of the authentication response sent back to the client.
====