You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: content/nim/admin-guide/authentication/oidc/keycloak-setup.md
+26Lines changed: 26 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -47,9 +47,16 @@ Follow these steps to configure Keycloak.
47
47
48
48
After the client is created, configure it as follows:
49
49
50
+
If Keycloak is version < 18.x
51
+
50
52
1. On the **Settings** tab, in the **Access Type** list, select **confidential**.
51
53
2. On the **Mappers** tab, select **Add Builtin**, and select **groups**. This exports the user's Keycloak Realm Role information for NGINX Instance Manager to use.
52
54
55
+
If Keycloak is version >= 18.x
56
+
57
+
1. On the **Settings** tab, enable the **Client authentication** toggle under the Capability config. Also, enable the **Direct Access Grants** and **Service Account** roles in the **Authentication flow** section.
58
+
2. Select the **Client Scopes** tab, under the list of scopes click on the scope with the name **<client_name>-dedicated (nim-dedicated)**. Under the **Mappers** tab, click **Configure new Mapper** and select **From predefined mappers**. In the **Add predefined mappers** section, search for **groups** mapper and select **Add groups mapper**.
59
+
53
60
### Create Keycloak Roles
54
61
55
62
NGINX Instance Manager User Groups will map to Keycloak **Realm Roles**; Keycloak Client Roles are **not** mapped. Use Keycloak top-level roles (Realm Roles).
@@ -119,6 +126,8 @@ To configure NGINX Instance Manager with the necessary OIDC settings, follow the
119
126
120
127
- Export the environment variables:
121
128
129
+
If Keycloak is version < 18.x:
130
+
122
131
```bash
123
132
# Either the FQDN or the IP address is suitable for these environment variables.
124
133
export KEYCLOAK_IP="<insert-keycloak-IP>"
@@ -134,6 +143,23 @@ To configure NGINX Instance Manager with the necessary OIDC settings, follow the
0 commit comments