SCIM provisioning
Your identity provider adds, updates and removes members, and maps its groups to Cueston roles.
With SCIM 2.0, removing someone in your identity provider removes their access to Cueston. Set it up in Settings → Security → SCIM provisioning.
Connect your identity provider
- Set up single sign-on and verify your email domains first. SCIM only creates or attaches accounts at domains your workspace has verified.
- Choose Generate token. Copy the bearer token (it starts with
scim_); you won't see it again. - In your identity provider's SCIM 2.0 app, paste the base URL and the token.
| Setting | Value |
|---|---|
| SCIM base URL | https://app.cueston.com/api/scim/v2 |
| Authentication | HTTP header: Authorization: Bearer scim_… |
| Unique identifier for users | userName (the email address) |
In Okta, use these in the app's Provisioning settings (SCIM connector base URL, unique identifier field userName, authentication mode HTTP Header). In Microsoft Entra ID, use the base URL as the Tenant URL and the token as the Secret Token.
Treat the token like a password: it can add and remove members. Rotating it stops the old one right away.
What SCIM does
- Create or activate a user: they join the workspace.
- Deactivate or delete a user: their membership is removed, their API keys in this workspace are revoked and their sessions end. Their other workspaces aren't affected.
- Groups to roles: map identity-provider groups to Cueston roles in Settings. People in mapped groups get the highest mapped role; people in no mapped group get the default role. Without mappings, SCIM only sets the default role when someone joins.
- The workspace owner can't be deactivated, deleted or have their role changed through SCIM.
Endpoints
| Endpoint | Methods |
|---|---|
/Users | GET (list and filter), POST |
/Users/{id} | GET, PUT, PATCH, DELETE |
/Groups | GET (list and filter), POST |
/Groups/{id} | GET, PUT, PATCH, DELETE |
/ServiceProviderConfig, /Schemas, /ResourceTypes | GET |
- Responses are
application/scim+json; errors use the SCIM error schema. - Filters:
eqclauses joined withand. Users filter onuserName,emails.value,externalId,idandactive; groups ondisplayName. Pages usestartIndexandcount(up to 200). PATCHis supported; bulk operations, sorting, ETags and password changes aren't.- Each token can make 600 requests a minute.