Organizations
SCIM provisioning
Let your identity provider create people, group them and deactivate them over SCIM 2.0.
Built Your identity provider creates people, puts them in groups and deactivates them over SCIM 2.0 (RFC 7643 and 7644). The owner or an admin makes the token in the Console under Sign-in rules → Single sign-on.
Connect your provider#
| Setting | Value |
|---|---|
| Base URL | https://api.openpulse.org/scim/v2 |
| Authentication | HTTP header, Authorization: Bearer scim_… |
| Unique identifier | userName |
The token is shown once. Make one per provider and give it a label. Revoking a token refuses the provider holding it from that moment on. The token list shows when each one was last used.
What your provider's actions do#
| Your provider | OpenPulse |
|---|---|
| Creates a user | Invites the person by email as a member. The invitation lasts 30 days, and accepting it binds their own OpenPulse identity. |
| Updates a profile | Keeps the name and email it holds for the person. |
Sets active to false, or deletes the user | Ends the membership and the person’s group memberships, ends their sign-ins to the organization’s apps at once and revokes an invitation that is still open. With Private access, their devices and grants leave the network. |
| Sets a user active again | Brings a person who has joined before back as a member, or invites them again. |
| Pushes groups | Creates the organization’s groups and their members. Apps receive them in the groups claim. |
Endpoints#
| Path | Methods |
|---|---|
/Users | GET, POST |
/Users/{id} | GET, PUT, PATCH, DELETE |
/Groups | GET, POST |
/Groups/{id} | GET, PUT, PATCH, DELETE |
/ServiceProviderConfig | GET |
/ResourceTypes | GET |
/Schemas | GET |
What the server supports#
| Feature | Support |
|---|---|
| PATCH | Yes: add, replace and remove, in the forms Okta and Entra ID send. |
| Filter | One attribute eq "value" clause. Users filter on userName, externalId or emails.value; groups on displayName, externalId or id. |
| Paging | startIndex and count. The default page is 100 and the largest is 200. |
| Bulk, sort, ETag, change password | No. |
Attributes#
A user keeps userName, externalId, displayName, name.givenName, name.familyName, one email and active. OpenPulse ignores what it does not keep, such as title, locale, password and the enterprise extension.
A group is named from its displayName: Prod Access becomes prod-access, up to 32 characters. A group of that name made earlier in the Console is taken over.
Each user carries a read-only extension, urn:openpulse:params:scim:schemas:extension:2.0:User, with the person's did once they have accepted and invited while their invitation is open.
Errors#
Errors use the SCIM error shape with application/scim+json.
| Status | scimType | Meaning |
|---|---|---|
| 400 | invalidFilter | The filter is not one the server answers. |
| 400 | invalidValue | A value is missing or has the wrong type, for example no email to invite. |
| 400 | mutability | The request would deprovision the organization’s owner. |
| 401 | The bearer token is missing, unknown or revoked. | |
| 404 | No such resource. | |
| 409 | uniqueness | A user with that userName exists. |
In the audit log#
Changes appear in your audit log as member.provisioned, member.deprovisioned, invite.revoked, scim.token_created and scim.token_revoked. The actor of a provisioning change is scim:<token id>.