How to use SCIM with the Unified API
October 3, 2024
Unified.to's SCIM API gives you SCIM 2.0 Users and Groups endpoints over its HR & Directory integrations, so a SCIM client can list, create, update and delete users in a customer's HR system or directory, including systems with no SCIM support of their own. This guide is for developers who already use SCIM (System for Cross-domain Identity Management, the RFC 7643 and RFC 7644 standard for user and group provisioning).
If your product already provisions users over SCIM, you can reuse that client across more systems.
Before you begin
This guide assumes you already have a basic understanding of SCIM and its purpose in identity management. You can read more about it in the official specification.
What endpoints does Unified.to's SCIM API provide?
Unified.to's SCIM endpoints are based on RFC 7644, and each is scoped to one connection:
- Users:
POST /scim/{connection_id}/users(create),GET /scim/{connection_id}/users(list),GET /scim/{connection_id}/users/{id}(get),PUTorPATCH /scim/{connection_id}/users/{id}(update),DELETE /scim/{connection_id}/users/{id}(delete) - Groups: the same operations on
/scim/{connection_id}/groups
List requests accept filter, startIndex and count for paging, and sortBy and sortOrder. Responses use the SCIM schemas; send Accept: application/scim+json for the SCIM media type.
View the API references for:
An existing SCIM client can call these endpoints with the connection ID in the path. Which operations work depends on the integration (see below).
Which SCIM extensions does Unified.to support?
In addition to the core SCIM schema, Unified.to supports the following extensions:
'urn:ietf:params:scim:schemas:extension:enterprise:2.0:User'
'urn:ietf:params:scim:schemas:extension:lattice:attributes:1.0:User'
'urn:ietf:params:scim:schemas:extension:peakon:2.0:User'
The enterprise extension carries employee number, cost centre, organization, division, department and manager; the Lattice and Peakon extensions carry the attributes those tools expect.
Which integrations work with the SCIM API?
Any HR & Directory integration that supports the Employee object works with Unified.to's SCIM API, whether or not the vendor supports SCIM itself: Unified.to translates each SCIM call into that integration's own API. That covers most of Unified.to's 951 HR & Directory integrations.
Reads work wherever the integration lists employees; creates, updates and deletes work only where it writes them. As of 19 October 2026, Okta, Microsoft Entra ID, Google Workspace Directory, JumpCloud, Personio and Ceridian Dayforce create, update and remove employees; BambooHR and HiBob create and update them; Workday and Remote.com are read-only for employees. An operation an integration doesn't support returns 501. Each integration's Feature Support tab lists its methods.
Should I use the SCIM API or the HR & Directory API?
Use the SCIM API when your product already speaks SCIM and you want to create, update or remove accounts with it. Use the HR & Directory API when you need more than identity: employment status, start and end dates, managers, locations, time off or payroll. Both read the same employee records.
How do I find out when users change?
The SCIM API itself doesn't send webhooks. Subscribe to HR & Directory employee and group webhooks on supported integrations. They're native on integrations such as HiBob, Personio, Google Workspace Directory and Microsoft Entra ID, and come from virtual webhooks on integrations such as BambooHR, Workday and Okta, which check at an interval you set, as often as every minute on paid plans.
The SCIM API is on every plan. It isn't available to enterprise-managed (ema_) tokens. Each request goes to the source system; Unified.to keeps no customer records at rest, and connection credentials and operational metadata are encrypted at rest.