Directory provisioning (SCIM)
Connect your company directory so people arrive in the workspace when they join, their groups and profile follow the directory, and their access ends the moment they leave.
4 min read
Before you startCopy link to this section
Provisioning is switched on for the workspace by whoever runs it. Once it is, Admin › Enterprise controls shows SCIM provisioning as On, with the directory base address to give your directory: https://<your-workspace>/api/auth/scim/v2. Okta, Microsoft Entra ID, OneLogin, JumpCloud and other directories that speak SCIM 2.0 all take the same two things: that address and a token.
Provisioning creates accounts; it never creates a password or any other way in. People still sign in through your identity provider, so set up single sign-on first.
Directory tokensCopy link to this section
Under Directory tokens on the same page, give the token a Name, choose an Overlap (hours) and press Issue token. Copy it into your directory straight away: it is shown only once, and the workspace keeps only a fingerprint of it.
- The overlap runs from 0 to 168 hours, 24 by default. Every older token keeps working until it ends, so you can switch the directory over without a failed sync.
- Up to five issued tokens can be in use at once. Each shows when it was last used and who issued it.
- Token set up with the deployment is the one the workspace started with. Stop accepting it now retires it once your directory uses an issued token.
- Revoke stops a token at once. If your directory still uses it, provisioning fails until you give it another.
What the directory sendsCopy link to this section
- A person created in the directory gets an account here. Their role comes from the workspace, never from the directory: they start as a member, and only an administrator makes someone an administrator.
- Their directory groups become their groups here, which is what group policies, Team Bot assignment and approver groups read. Taking someone out of a group in the directory takes them out here too; a group a sign-in claim or an attribute rule gave them stays until that rule takes it away.
- Their title, department, division, organisation, cost centre, employee number, employee type and manager are kept as the directory sent them, and shown on the person's page under From the directory. They change in the directory, not here.
Under Using the directory, choose which of those facts the workspace acts on. Each is off until you turn it on:
- Reporting lines follow the directory: the manager it names becomes who the person Reports to.
- Take the time zone from the directory and Take the language from the directory: for people who never chose their own, at their next sign-in.
- Bots may know people's directory profile: a Bot working for someone knows their title, department and manager, and nothing else from the directory.
- Directory groups count for the sign-in role rules: a role rule can then give a role to a directory group.
Groups from attributesCopy link to this section
Groups from attributes fills a group with everybody who matches a rule, such as department equals Sales. The rules are applied when you save them, at each person's sign-in, and every 15 minutes, so a change in the directory reaches the group without anyone doing anything.
People a rule added leave the group when they stop matching; people added any other way stay. Removing a rule keeps its members in the group as ordinary members.
When someone leavesCopy link to this section
When the directory deactivates or deletes a person, their access is suspended first, every time: their sessions end, their address is blocked, the accounts they connected are disconnected and their Bots' computers stop.
Under When the directory removes someone, choose what happens next:
- The person: Stay suspended (they can be restored, and are restored automatically if the directory turns them back on) or Remove permanently (never the last administrator or anyone under legal hold).
- Their Bots: Leave as they are, Pause, Hand to a successor (with routines switched off for the Successor to review) or Move to the trash.
Note
Turning someone back on in the directory lifts only a block the directory caused. A removal an administrator made stands until an administrator lifts it.
Checking what arrivedCopy link to this section
Provisioning requests lists each request your directory made, newest first, with who it was about and how it went. Show narrows it to Failed requests when a sync goes wrong. Requests are kept for 30 days.
The audit trail records each person the directory creates, deactivates or turns back on, each token issued or revoked, and each change to what happens when someone leaves.
Last updated