add instructions to configure SCIM integration in Okta (#18710)
Juan Cañete committed
Oct 8, 2024 at 09:57 UTC
2a5c8c8a205b8317b8da8eac83c793ddbfa55f9d
1 file changed
+27
-11
integrations/cloud-authentication/metadata.yaml
+27
-11
@@ -125,6 +125,20 @@
125
- The Space must be on a paid plan
126
- OIDC/SSO integration must already be enabled in one of your Spaces
127
128
+ ### Supported Features
129
+ This integration adheres to SCIM v2 specifications. Supported features include:
130
+
131
+ - User Resource Management (urn:ietf:params:scim:schemas:core:2.0:User)
132
+ - Create users
133
+ - Update user attributes
134
+ - Deactivate users
135
+ - Patch operations: Supported
136
+ - Bulk operations: Not supported
137
+ - Filtering: Supported (max results: 200)
138
+ - Password synchronization: Not supported, as we rely on SSO/OIDC authentication
139
+ - eTag: Not supported
140
+ - Authentication schemes: OAuth Bearer Token
141
+
142
### Netdata Configuration Steps
143
1. Click on the Space settings cog (located above your profile icon).
144
2. Click on the **User Management** section and access **Authentication and Authorization** tab.
@@ -136,6 +150,19 @@
150
- **Base URL**: Use this URL as the base URL for your SCIM client.
151
- **Token**: Use this token for Bearer Authentication with your SCIM client.
152
153
+ ## Client Configuration Steps
154
+
155
+ ### Okta
156
+ If you're configuring SCIM in Okta, and you already have the Token from the previous section, follow these steps:
157
+
158
+ 1. Go to the **Applications** menu on the left-hand panel and select the **Netdata** application.
159
+ 2. In the **Netdata** application, navigate to the **Provisioning** tab.
160
+ 3. Click on **Configure API Integration** and check the box for **Enable API Integration**.
161
+ 4. Enter the Token (obtained in the *Netdata Configuration Steps* section) into the **API Token** field, then click **Test API Credentials** to ensure the connection is successful.
162
+ 5. If the test is successful, click **Save** to apply the configuration.
163
+
164
+ ## Troubleshoot
165
+
166
### Rotating the SCIM Token
167
You can rotate the token provided during SCIM integration setup if needed.
168
@@ -146,17 +173,6 @@
173
4. Click **Regenerate Token**.
174
5. If successful, you will receive a new token for Bearer Authentication with your SCIM client.
175
149
- ### Supported Features
150
- This integration adheres to SCIM v2 specifications. Supported features include:
151
-
152
- - User Resource Management (urn:ietf:params:scim:schemas:core:2.0:User)
153
- - Patch operations: Supported
154
- - Bulk operations: Not supported
155
- - Filtering: Supported (max results: 200)
156
- - Password synchronization: Not supported, as we rely on SSO/OIDC authentication
157
- - eTag: Not supported
158
- - Authentication schemes: OAuth Bearer Token
159
-
176
### User Keying Between SCIM and OIDC
177
Our SCIM (System for Cross-domain Identity Management) integration utilizes OIDC (OpenID Connect) to authenticate users.
178
To ensure users are correctly identified and authenticated between SCIM and OIDC, we use the following mapping: