Regenerate integrations docs (#19970)
Co-authored-by: ilyam8 <22274335+ilyam8@users.noreply.github.com>
Netdata bot committed
Mar 26, 2025 at 08:45 UTC
cdeb69da73cdad96a778f6196bc7ed007e9ae86b
1 file changed
+28
integrations/cloud-authentication/integrations/scim.md
+28
@@ -30,9 +30,13 @@ The System for Cross-domain Identity Management (SCIM) specification is designed
30
This integration adheres to SCIM v2 specifications. Supported features include:
31
32
- User Resource Management (urn:ietf:params:scim:schemas:core:2.0:User)
33
+- Group Resource Management (urn:ietf:params:scim:schemas:core:2.0:Group)
34
- Create users
35
- Update user attributes
36
- Deactivate users
37
+- Create groups
38
+- Associate users to groups
39
+- Nested groups supported
40
- Patch operations: Supported
41
- Bulk operations: Not supported
42
- Filtering: Supported (max results: 200)
@@ -62,6 +66,30 @@ If you're configuring SCIM in Okta, and you already have the Token from the prev
66
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.
67
5. If the test is successful, click **Save** to apply the configuration.
68
69
+## Setting Up Membership Rules
70
+
71
+1. Click on the Space settings cog (located above your profile icon).
72
+2. Navigate to the **User Management** section and select the **Groups** tab.
73
+3. Once your SCIM client has provisioned groups to Netdata, you'll see a **Create a new rule** button.
74
+4. Click this button to open the membership rule configuration panel.
75
+5. For each rule, configure the following three components:
76
+ - **SCIM Group**: Select the SCIM group that should be mapped
77
+ - **Netdata Role**: Choose the role that members of this group should have in the space
78
+ - **Space Rooms**: (Optional) Select specific rooms that these users should be members of
79
+6. Click **Save** to activate the configuration.
80
+7. Repeat steps 4-6 to create additional rules as needed.
81
+
82
+### How Membership Rules Work
83
+
84
+- When a user in your identity provider is assigned to a SCIM group, they will automatically be added to your Netdata Space with the role and room access defined in your rules.
85
+- If a user is removed from a SCIM group, their access will be adjusted according to your rules.
86
+- When users match multiple rules, they are granted the highest permission level from all their matching rules.
87
+- Changes to membership rules take effect immediately for new and existing users.
88
+
89
+**Important Considerations**
90
+- If you had previously manually invited users who are now being provisioned through SCIM, their existing roles and room access will be updated to match your rules.
91
+- You must create at least one rule that assigns the **Admin** role to a SCIM group. If no admin role is defined in your rules, Netdata will not implement any user membership changes and will display a warning in the workspace.
92
+
93
## Troubleshoot
94
95
### Rotating the SCIM Token