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
+23-11Lines changed: 23 additions & 11 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -47,15 +47,19 @@ 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
50
+
#### For Keycloak versions earlier than 18.x
51
51
52
-
1. On the **Settings** tab, in the **Access Type**list, select**confidential**.
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
+
1. On the **Settings** tab, set **Access Type**to**confidential**.
53
+
2. On the **Mappers** tab, select **Add Builtin** and choose**groups** to export Keycloak Realm Role information for NGINX Instance Manager.
54
54
55
-
If Keycloak is version >= 18.x
55
+
#### For Keycloak versions 18.x and later
56
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**.
57
+
1. On the **Settings** tab, under **Capability config**, enable **Client authentication**.
58
+
2. In the **Authentication flow** section, enable **Direct Access Grants** and **Service Account**.
59
+
3. Go to the **Client Scopes** tab.
60
+
- Select the scope named **<client_name>-dedicated (nim-dedicated)**.
61
+
- On the **Mappers** tab, click **Configure new Mapper** and choose **From predefined mappers**.
62
+
- Search for **groups** and select **Add groups mapper**.
59
63
60
64
### Create Keycloak Roles
61
65
@@ -126,7 +130,7 @@ To configure NGINX Instance Manager with the necessary OIDC settings, follow the
126
130
127
131
- Export the environment variables:
128
132
129
-
If Keycloak is version < 18.x:
133
+
- **For Keycloak versions earlier than 18.x**:
130
134
131
135
```bash
132
136
# Either the FQDN or the IP address is suitable for these environment variables.
@@ -143,7 +147,7 @@ If Keycloak is version < 18.x:
0 commit comments