Steps for mapping guests in Keycloak SAML #8572
Conversation
|
Newest code from mattermost has been published to preview environment for Git SHA 2ef3c9c |
1 similar comment
|
Newest code from mattermost has been published to preview environment for Git SHA 2ef3c9c |
|
Hi @cwarnermm and @hanzei The wording should be fine but unfortunately, I don't know how to preview what
|
- Fix an italic fromat markdown - Added whitespace above images for consistency
|
Newest code from mattermost has been published to preview environment for Git SHA 73626b6 |
|
Hi @DHaussermann! Docs previews are auto-generated for all docs PRs, and each time changes are made to a PR, a new preview is generated. The github-actions bot will provide a link to the preview like this: And when you click that link, you're taken to a build of the docs that includes your changes. From your file changes, copy the file path (omitting |
|
Newest code from mattermost has been published to preview environment for Git SHA e390cce |
|
@cwarnermm or @hanzei this change is ready for review. |
hanzei
added
1: Dev Review
cwarnermm
left a comment
cwarnermm
left a comment
There was a problem hiding this comment.
Thanks, @DHaussermann! Editorial feedback provided inline.
| Configuing a SAML user as a Guest in Keycloak | ||
| --------------------------------------------- | ||
|
|
||
| 1. In the Mattermost **System Console** go to **Authentication > SAML**. |
There was a problem hiding this comment.
| 1. In the Mattermost **System Console** go to **Authentication > SAML**. | |
| 1. In Mattermost, go to **System Console > Authentication > SAML**. |
|
|
||
| 1. In the Mattermost **System Console** go to **Authentication > SAML**. | ||
|
|
||
| 2. Set the **Guest Attribute** to the a value you will use to designate which SAML users are guests |
There was a problem hiding this comment.
| 2. Set the **Guest Attribute** to the a value you will use to designate which SAML users are guests | |
| 2. Set the **Guest Attribute** to designate which SAML users are guests. |
|
|
||
|
|
||
|
|
||
| 3. In the Keycloak admin UI add a user attribute mapper for guests |
There was a problem hiding this comment.
| 3. In the Keycloak admin UI add a user attribute mapper for guests | |
| 3. In the Keycloak administration interface, add a user attribute mapper for guests. |
|
|
||
| 3. In the Keycloak admin UI add a user attribute mapper for guests | ||
|
|
||
| - Select *Clients* from the LHS menu |
There was a problem hiding this comment.
| - Select *Clients* from the LHS menu | |
| a. Select **Clients** from the LHS menu. |
| 3. In the Keycloak admin UI add a user attribute mapper for guests | ||
|
|
||
| - Select *Clients* from the LHS menu | ||
| - Select *mattermost* from the list |
There was a problem hiding this comment.
| - Select *mattermost* from the list | |
| b. Select **mattermost** from the list. |
|
|
||
| 4. In Keycloak specify which users are guest by adding the attribute under **User details** | ||
|
|
||
| - Select *Users* from the LHS menu |
There was a problem hiding this comment.
| - Select *Users* from the LHS menu | |
| a. Select **Users** from the LHS menu. |
| 4. In Keycloak specify which users are guest by adding the attribute under **User details** | ||
|
|
||
| - Select *Users* from the LHS menu | ||
| - Click the username of the desired user |
There was a problem hiding this comment.
| - Click the username of the desired user | |
| b. Select the username of the desired user. |
|
|
||
| - Select *Users* from the LHS menu | ||
| - Click the username of the desired user | ||
| - Select *Attribute* tab and click *+ add an attribute* |
There was a problem hiding this comment.
| - Select *Attribute* tab and click *+ add an attribute* | |
| c. Select the **Attribute** tab and select **+ add an attribute**. |
| - Select *Users* from the LHS menu | ||
| - Click the username of the desired user | ||
| - Select *Attribute* tab and click *+ add an attribute* | ||
| - Add the key and value as shown |
There was a problem hiding this comment.
| - Add the key and value as shown | |
| d. Add the key and value. |
| - Add the key and value as shown | ||
|
|
||
| .. image:: ../../images/guest-user-attribute.png | ||
| :alt: <Adding attribute to a user> |
There was a problem hiding this comment.
| :alt: <Adding attribute to a user> | |
| :alt: An example of adding an attribute to a user. |
cwarnermm
added
3: Reviews Complete
Steps for mapping guests in Keycloak SAML