Docs Security & access
Security & access
SCIM provisioning
Let your identity provider create, update and deactivate Kumo.io members automatically over SCIM 2.0, so someone you offboard in your directory loses their Kumo.io membership too.
What SCIM does in Kumo.io
SCIM keeps Kumo.io's member list in step with your directory. Your identity provider is the source of truth for who exists and which groups they're in. Kumo.io stays the source of truth for what each person can do.
- Users your identity provider pushes become members of the account. Updating them in the directory updates them in Kumo.io.
- Deactivating or deleting a user in the directory deactivates their membership. Kumo.io never hard-deletes the person, so their history in the audit log is kept, and reactivating them in the directory restores them.
- Groups and their membership are synchronised too.
SCIM never signs anyone in, and it never grants permissions on its own. On a self-hosted installation, a provisioned member has no role until someone gives them one. Pair SCIM with OpenID Connect or SAML for sign-in, and use roles for access.
Hosted Kumo.io
On hosted Kumo.io, SCIM provisions the members of your Kumo.io account, and every member can log in to the account's workspace. Set it up at https://account.kumo.io/settings/scim (Provisioning in your Kumo.io account; the page is titled SCIM Provisioning). In a workspace, the Your Kumo.io Account group in Settings links there.
- Plan. SCIM needs the Enterprise plan to set up a directory or create a token. After a move to a plan without it, existing tokens keep provisioning, and you can still revoke tokens and disable the directory.
- Role. Only an account owner can see and change these settings.
Set it up
- Open https://account.kumo.io/settings/scim.
- Enter a Directory name and choose the Provider: Okta, Microsoft Entra ID or Generic SCIM 2.0.
- Select Enable SCIM, then copy the bearer token with Copy SCIM Token. It is shown once.
- In your identity provider, set the SCIM base URL to
https://account.kumo.io/scim/v2(Copy SCIM Base URL copies it), and choose bearer-token authentication with that token.
Each token belongs to your account's directory and works only for SCIM provisioning. Rotate Token, Revoke and Disable work as described for self-hosted below.
What hosted SCIM does
- Users your identity provider pushes join your Kumo.io account as a Member. They then sign in through SAML single sign-on.
- Groups and their membership are synchronised, but they carry no roles: a hosted account has only the Owner and Member roles.
- Deactivating or deleting a user in the directory suspends their membership. They can no longer log in to the account's workspaces, and a session they already have open ends within 30 minutes.
- The last owner stays. Kumo.io refuses to deprovision the account's last active owner.
The operations, filters and limits are the same as on a self-hosted installation (below).
The rest of this page applies to self-hosted installations.
Before you start
- Plan. On a self-hosted installation, SCIM is part of Enterprise (Licensed). On other plans the SCIM page shows a plan notice instead of the setup form.
- Role. You need the
scim.managepermission, which the Account owner and Account admin roles include.
Set up a directory
- Open Settings › SCIM Provisioning.
- Enter a Directory name, for example
Corporate Okta. - Choose the Provider: Okta, Microsoft Entra ID or Generic SCIM 2.0.
- Select Enable SCIM.
- Copy the bearer token with Copy SCIM Token. It is shown once.
- Copy the base URL with Copy SCIM Base URL. It is your Kumo.io address followed by
/scim/v2.
Then, in your identity provider's SCIM or provisioning settings:
- Set the SCIM connector base URL, or tenant URL, to the SCIM base URL.
- Choose bearer-token (HTTP header) authentication and paste the SCIM token.
- Turn on the provisioning actions you want: create users, update user attributes, deactivate users, and push groups.
The token works only for SCIM provisioning into this directory. It can't read your graph or call any other part of the Kumo.io API.
What Kumo.io supports
| Area | Support |
|---|---|
| Users | Create, read, list, replace, update (PATCH) and delete |
| Groups | Create, read, list, replace, update (PATCH, including adding and removing members) and delete |
| Discovery | /ServiceProviderConfig, /Schemas and /ResourceTypes |
| Filters | eq, ne, co, sw, ew and pr, combined with and, or and not |
| Not supported | Bulk operations and nested groups |
User names are unique without regard to case. Kumo.io keeps the case your identity provider sent.
A PATCH is all-or-nothing: if one operation in it is invalid, none of it is applied.
Groups and roles
Groups are synchronised, but Kumo.io doesn't yet let you map a directory group to a Kumo.io role from Settings. Grant roles to provisioned members under Settings › Roles & Access. Read Roles and permissions.
Rotate or revoke the token
The directory's tokens are listed with when they were created, when they were last used, and whether they're active.
- Rotate Token issues a new token, shown once. The old token keeps working until you revoke it, so you can update your identity provider without a gap.
- Revoke stops a token immediately. Your identity provider's provisioning fails until it has a working token.
Disable a directory
Select Disable and confirm. Provisioning from that directory stops immediately and its tokens stop authenticating. Existing members are not affected.
Safety rules
- Deprovisioning through SCIM can't remove the account's last Account owner.
- Provisioning activity is recorded in the audit log. Kumo.io keeps a hash of each request, never the raw payload.