-
Notifications
You must be signed in to change notification settings - Fork 37
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
feat: document how to add group attributes #3459
Merged
Merged
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -137,6 +137,7 @@ up Keycloak as an OIDC provider for Palette. | |
|
||
![Client Authentication creation screen number two](/keycloak/user-management_saml-sso_keycloak-05-client-authentication.webp "Client Authentication") | ||
|
||
|
||
11. Fill out the following fields with the instructions provided in the table. | ||
|
||
| **Field** | **Description** | | ||
|
@@ -206,16 +207,40 @@ Use the following steps to validate the SSO configuration. | |
|
||
![Image of project roles highlighted](/keycloak/user-management_saml-sso_keycloak-15-palette-project.webp "Palette Project") | ||
|
||
4. From the left **Main Menu**, select **Tenant Settings**. Next, click on **SSO** to access the SSO configuration page. | ||
|
||
### Syncing Keycloak Groups and Palette Teams | ||
karl-cardenas-coding marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
1. Switch back to the Keycloak admin console and modify the **profile** Client Scope. Navigate to the left **Main Menu** and | ||
select **Client Scope**. Click on the **Profile** button. | ||
|
||
![Image of keycloak mappers highlighted](/keycloak/user-management_oidc-sso-keycloak-19-keycloak-client-scopes.webp "Palette Project") | ||
karl-cardenas-coding marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
2. Within the **profile** Client scope details, click **Mappers**, then **Add mapper** and **By configuration**. | ||
|
||
3. Navigate to **Group Membership** in the Configure a new mapper modal. | ||
|
||
4. Next, ensure the **Name** and **Token Claim Name** fields are both **groups**. | ||
|
||
![Image of keycloak client scopes highlighted](/keycloak/user-management_oidc-sso-keycloak-20-keycloak-mapper.webp "Palette Project") | ||
karl-cardenas-coding marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
5. Deselect the radio button for **Full group path**. | ||
|
||
6. Save the add mapper page. | ||
|
||
You have now ensured that the groups for the Keycloak user are within the token attributes, ensure the Keycloak group and the Palette group match. | ||
|
||
### Using Default Teams | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 🚫 [vale] reported by reviewdog 🐶
karl-cardenas-coding marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
1. From the left **Main Menu**, select **Tenant Settings**. Next, click on **SSO** to access the SSO configuration page. | ||
Click on the **OIDC** tab to access the OIDC configuration page. Scroll down to the **SSO Admins** section and select | ||
the **admins** team from the **Default Team** drop-down Menu. Click on **Save**. | ||
|
||
5. Navigate back to the Keycloak admin console. From the left **Main Menu** click on **Users**. Create a user and ensure | ||
2. Navigate back to the Keycloak admin console. From the left **Main Menu** click on **Users**. Create a user and ensure | ||
the field **Username**, **Email**, and **First Name** are filled out. Click on **Save** to save the user. | ||
|
||
![Keycloak's management portal with the User view in focus](/keycloak/user-management_saml-sso_keycloak-17-keycloak-user.webp "Keycloak user") | ||
|
||
6. Next, click on the **Credentials** tab and assign the user password. | ||
3. Next, click on the **Credentials** tab and assign the user password. | ||
|
||
![Keycloak's management portal with the User view in focus that lists all current users](/keycloak/user-management_saml-sso_keycloak-18-keycloak-password.webp "Keycloak password") | ||
|
||
|
@@ -225,6 +250,7 @@ out the | |
[Creating users](https://www.keycloak.org/docs/latest/server_admin/index.html#proc-creating-user_server_administration_guide) | ||
guide to learn how to create users in Keycloak. | ||
|
||
|
||
## Resources | ||
|
||
- [Keycloak Documentation](https://www.keycloak.org/documentation) | ||
|
Binary file added
BIN
+51.6 KB
...ets/docs/images/keycloak/user-management_oidc-sso-keycloak-19-keycloak-client-scopes.webp
Binary file not shown.
Binary file added
BIN
+29.1 KB
static/assets/docs/images/keycloak/user-management_oidc-sso-keycloak-20-keycloak-mapper.webp
Binary file not shown.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🚫 [vale] reported by reviewdog 🐶
[spectrocloud-docs-internal.headings-title] Avoid using a noun that starts with an -ing in headings. Your heading starts with a word ending in 'ing'.