Skip to content
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.

Sign up for GitHub

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

chore: Add KeyCloak configuration #9

Merged
merged 4 commits into from
Nov 15, 2023
Merged

chore: Add KeyCloak configuration #9

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
1866809
chore: Add KeyCloak configuration
astsiapanay Nov 9, 2023
24fe986
Merge branch 'development' into keycloak-doc
astsiapanay Nov 9, 2023
54c1586
grant permission for the exchange token
astsiapanay Nov 9, 2023
f5bd68d
Merge branch 'development' into keycloak-doc
astsiapanay Nov 15, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 36 additions & 0 deletions docs/keycloak.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
## KeyCloak Configuration

Auth-helper uses token-exchange API in KeyCloak for access to external IdP. You need to grant permissions for the exchange
before running auth-helper: https://www.keycloak.org/docs/latest/securing_apps/#_client_to_client_permission

### Identity Provider
Go to the target realm in KeyCloak and open "Identity Providers". Choose the tab "Mappers" and create two mappers:

- *Idp*. The attribute denotes to the identity provider is used in KeyCloak. At the moment the valid value is "microsoft".
- *IdpAlias*. The attribute denotes to the alias name of the IdP configured in KeyCloak.

See the details below how to fill required fields in the mapper form to create mappers

| Name | Sync Mode Override | Mapper Type | User Attribute | User Attribute Value |
|----------|---------------------|---------------------|-------------|----------------------|
| Idp | Force | Hardcoded Attribute | idp | microsoft |
| IdpAlias | Force | Hardcoded Attribute | idpAlias | <your_idp_alias> |

### Client Scope

Go to "Client Scopes" in KeyCloak and choose the scope "dial". If the scope doesn't exist it should be created and be included to the client "chatbot-ui".

Go to the tab "Mappers" and create two mappers:

- *Idp*. Injects attribute value of "Idp" to the access token as a claim.
- *IdpAlias*. Injects attribute value of "IdpAlias" to the access token as a claim.

See the details below how to fill required fields in the mapper form to create mappers.

| Name | User Attribute | Token Claim Name | Claim JSON Type | Add to access token |
|------------|----------------|------------------|-----------------|---------------------|
| Idp | idp | idp | String | On |
| Idp Alias | idpAlias | idpAlias | String | On |

Note. The rest of flags should be turned off in the mapper form.