Skip to content

Commit 3284631

Browse files
committed
update scim docs
1 parent 785f2fe commit 3284631

File tree

1 file changed

+12
-6
lines changed

1 file changed

+12
-6
lines changed

src/segment-app/iam/scim.md

Lines changed: 12 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ To setup SCIM, you must first create an SSO connection. Once you [create your SS
1717

1818
Segment officially supports Okta, Azure AD, and OneLogin. However, you may still be able to use SCIM with another Identity Provider (IdP) by adapting the following instructions. If using a supported provider, start by searching for Segment in your provider's app catalog.
1919

20-
When you enable SCIM, your IdP asks for two values. One is the base URL, the Segment base URL is: https://scim.segmentapis.com/scim/v2
20+
When you enable SCIM, your IdP asks for two values. One is the "base URL", the Segment base URL is: https://scim.segmentapis.com/scim/v2
2121

2222
The other value needed is an API key or Authorization Header. To generate one, go to **Settings > Advanced Settings** in the Segment app, and find the SSO Sync section. Click **Generate SSO Token** and copy the generated token. Use this token for the API key or Authorization Header in your IdP.
2323

@@ -49,15 +49,17 @@ Segment user profiles only contain a `userName` (email) and `displayName`. Once
4949

5050
Segment workspace owners **cannot** delete Segment workspace member accounts using SCIM, the web UI, or the Segment API. A user must delete their own account using the Segment app. Workspace owners **can** remove members from the workspace using SCIM, the web UI, or the Segment API.
5151

52-
Some IdPs want to set users as inactive or active. Segment does not have an inactive state for user accounts. Similar functionality can be achieved by removing a user from your workspace. Setting an existing Segment user to active is similar to adding that user to the workspace.
52+
Some IdPs want to set users as "inactive" or "active." Segment does not have an "inactive" state for user accounts. Similar functionality can be achieved by removing a user from your workspace. Setting an existing Segment user to "active" is similar to adding that user to the workspace.
5353

5454
When your IdP updates a user to set `active: false` or attempts to delete a user, Segment removes the user from your Segment workspace. If your IdP attempts to create a user with an existing email, or set `active: true`, the existing user account is added to your workspace.
5555

56-
Any Segment group memberships **must be reassigned** when a user is removed and re-added from your workspace. Newly added workspace users have the “Minimal Workspace Access” permission by default. The “Minimal Workspace Access” role does not have access to any sources, destinations, etc.
56+
Any Segment group memberships **must be reassigned** when a user is removed and re-added from your workspace. Newly added workspace users have the "Minimal Workspace Access" permission by default. The "Minimal Workspace Access" role does not have access to any sources, destinations, etc.
57+
58+
This reassignment may happen automatically depending on how you have configured your IdP. If the user was assigned groups via your IdP, your IdP should automatically re-add the user within Segment. For this reason, we **strongly** recommend creating your groups within your IdP, pushing them into Segment, and maintaining an active link between your IdP and Segment.
5759

5860
## Creating Groups
5961

60-
Your IdP can create new groups in Segment using SCIM. All groups are created via SCIM start with Minimal Workspace Access." The Minimal Workspace Access permission does not have access to any sources, destinations, etc. To add more permissions to a group you must use the Segment web app.
62+
Your IdP can create new groups in Segment using SCIM. All groups are created via SCIM start with "Minimal Workspace Access." The "Minimal Workspace Access" permission does not have access to any sources, destinations, etc. To add more permissions to a group you must use the Segment web app.
6163

6264
## Updating Groups
6365

@@ -67,6 +69,10 @@ Your IdP can add or remove workspace members from existing groups via SCIM. Your
6769

6870
Your IdP can use SCIM to delete groups from your Segment workspace. Deleting a group within Segment does **not** remove its members from your workspace. You need to unassign users from Segment within your IdP for them to be removed from the workspace.
6971

70-
## Importing Users and Groups
72+
## Troubleshooting
73+
74+
When intergrating Segment and your IdP you may need to map attributes for users. The only attributes that Segment supports are `userName` and `displayName`.
75+
76+
You'll need to map an email (IdP) to `userName` (Segment). Depending on your IdP this attribute may be called `email` or simply `mail`. If your IdP uses emails for usernames, you can simply map `userName` (IdP) to `userName` (Segment).
7177

72-
Segment groups and users can be imported to your IdP if your IdP supports this feature.
78+
If your IdP supports the `displayName` attribute this can be mapped directly to the Segment `displayName` attribute. If not, most IdPs can create a "macro mapping" which would allow you to map multiple fields to a single field within Segment, such as `{firstName} {lastName}` (IdP) to `displayName` (Segment). If your IdP doesn't support this concept you can map `firstName` (IdP) to `displayName` (Segment).

0 commit comments

Comments
 (0)