Before you start
- An Owner or Admin role in the organization.
- A plan (opens in a new tab) that includes SCIM provisioning.
- An identity pool with its verified domains. See Set up single sign-on.
- An identity provider (IdP) that provisions through SCIM 2.0, such as Okta or Microsoft Entra ID.
SCIM (System for Cross-domain Identity Management) lets your identity provider manage members for you. When it assigns someone to SplitSecure, they become a member. When it deactivates or removes them, they lose access to the Web App, unless another identity pool of your organization still links them. See A member in several pools below. Its groups become groups in SplitSecure.
Deactivating or removing a member in your identity provider does not take their devices out of your Guardian Teams. To stop their votes, revoke their membership in each team: see Revoke a membership.
Each identity pool has its own SCIM tokens. A user’s email domain must be one of the pool’s domains.
Create a token
In the Web App
- In the sidebar, click Organization → Advanced → SSO / Identity pools.
- Click the pool.
- On the SCIM tokens card, click Create token.
- Enter a Label, for example
Okta provisioning. - Click Create token.
- Copy the token, and the SCIM base URL above it.
- Click Done.
The token is shown once. Store it in your identity provider right away. It never expires: delete it when you stop using it.
In your identity provider
- In your identity provider’s SCIM settings, paste the SCIM base URL as the base URL.
- Paste the token as the bearer token.
- Map the user’s primary email,
userName,displayNameandexternalId. - Turn on the push of users and groups.
The identity provider must send an externalId for each user, and a primary email for each active user.
On the pool’s page, the provisioned people appear under Linked users, and the pushed groups under Linked groups.
What each change does
| In your identity provider | In SplitSecure |
|---|---|
| Assign a user | They become a member, with the organization’s default role and the pool’s default seat |
| Deactivate a user | Their membership is suspended, their seat is freed and their single sign-on is disabled. They leave every SCIM group |
| Reactivate a user | Their membership and single sign-on come back, and they rejoin their SCIM groups. They take a seat if one is free |
| Remove a user | Their membership is deleted. Their account is deleted too if they have no other organization and no social sign-in |
| Push a group | A group appears on Groups, with the pool’s name as its source. Its name is unique within the pool |
| Rename or remove a group | The group in SplitSecure is renamed or deleted |
You cannot suspend or remove a SCIM member, or change their SCIM groups, in the Web App. Make the change in your identity provider.
A member in several pools
A member can be linked to several identity pools of the same organization.
- Deactivation suspends them only when no other pool still has them active.
- Removal deletes the membership only when no other pool links them at all, active or not.
In both cases, they leave the SCIM groups of every pool, including the pools that keep them. They rejoin those groups at each group’s next push.
Seats and limits
A push never fails for lack of a seat. When every seat of the member’s kind is taken, the member is created without one. Administrators receive an email titled No more Guardian seats in, or No more Basic seats in, followed by your organization’s name, at most once a day for each seat kind. See Manage seats.
A push fails when the organization has reached its member limit. The identity provider receives 409 with organization is full, and the user is not created.
When a push fails
SplitSecure applies each push at once and keeps no queue.
When a temporary internal failure stops a change, SplitSecure answers 503, with a message that ends in please retry. Your identity provider retries it, and the retry completes the change. A new user may already appear under Linked users before the retry adds their membership. If your identity provider gives up, the two sides stay out of step until its next push of that user or group. Check its provisioning log for failed requests, and push again.
Other refusals are final and are not retried. A user without a primary email gets 400, a full organization gets 409, and a plan without SCIM gets 403. Fix the cause, then push again. The troubleshooting table below lists each one.
Rotate or revoke a token
In the Web App
- Create a new token, as in Generate the token above.
- Paste it in your identity provider.
- On the SCIM tokens card, click Delete in the old token’s row.
- Click Delete token.
Requests with a deleted token are refused at once.
Troubleshooting
| Issue | Solution |
|---|---|
The identity provider gets 401 | The token is wrong or was deletedCreate a new token and paste it |
The identity provider gets 400 with an active user requires a primary email | The user has no emailGive the user an email, or map one |
The identity provider gets 400 on a user’s domain | The email’s domain is not one of the pool’s verified domainsAdd the domain to the pool |
The identity provider gets 409 with organization is full | The organization has reached its member limitRemove members, or move to a plan (opens in a new tab) that allows more |
The identity provider gets 409 on a group | Another group in the pool has this nameRename one of the groups |
The identity provider gets 403 with SCIM provisioning is not available on your organization’s plan | Your plan does not include SCIMMove to a plan (opens in a new tab) that includes it. Deactivations and removals still go through |
| Create token is missing | Your plan does not include SCIMMove to a plan that includes it |
External resources
- SplitSecure plans (opens in a new tab): See the plans and their limits