SCIM 2.0 provisioning
Edition: commercial (extractit-ee). Without it /scim/v2 answers 404.
ExtractIt serves SCIM 2.0 (RFC 7643/7644) at <DX_PUBLIC_URL>/scim/v2, built with
scim2-models (Apache-2.0). Requests and responses are
application/scim+json; every error is a SCIM Error (also 401).
Tokens
POST /v1/org/scim-tokens (Owner) creates a Bearer token scim_…, shown once; only its HMAC is
stored. GET /v1/org/scim-tokens lists them and the base URL; DELETE /v1/org/scim-tokens/{id}
revokes one immediately. To rotate, create a new token, switch the IdP and revoke the old one.
The token decides the organization (and the RLS context): a token of organization A never reads
or changes B's users.
Endpoints
| Endpoint | Methods |
|---|---|
/ServiceProviderConfig, /ResourceTypes, /Schemas |
GET |
/Users |
GET (filter, startIndex, count), POST |
/Users/{id} |
GET, PUT, PATCH (add, replace, remove), DELETE |
/Groups |
GET (filter), POST |
/Groups/{id} |
GET, PUT, PATCH (members), DELETE |
externalIdanduserNameare unique per organization: a repeated one is 409uniqueness.- Filters use the SCIM grammar (
userName eq "ana@example.com",displayName eq "dx-reviewers"); an invalid one is 400invalidFilter. Pagination is 1-based (startIndex) withcount≤ 200. - Bulk, sorting, ETags and password changes are not supported (announced in
ServiceProviderConfig). The enterprise extension Entra ID sends is accepted and ignored.
Roles and memberships
A user's role comes from its groups: each group's displayName is looked up in the SSO
role_mappings (see SSO), else default_role. Without a role the user has no membership
until a mapped group includes it. Changing a group's members changes their roles. Owners are never
changed or removed through SCIM.
active=false (PATCH or PUT) or DELETE removes the membership and deletes the user's sessions in
the organization: the next request with a previous session is 401.
Configure the IdP
- Entra ID: Enterprise application → Provisioning → Tenant URL
<DX_PUBLIC_URL>/scim/v2, Secret token = thescim_…token. Attribute mappings:userPrincipalName→userName,objectId→externalId. - Okta: SCIM 2.0 app → Base URL
<DX_PUBLIC_URL>/scim/v2, Unique identifieruserName, Authentication mode HTTP Header with the token; enable Push New Users, Push Profile Updates, Push Groups.
Tests and pending manual check
ee/tests/test_ee_scim_db.py replays the request sequences documented by Entra ID and Okta
(ee/tests/fixtures/scim/). No real Entra ID or Okta tenant was used: a manual run against a
test tenant is pending before selling SCIM (risk accepted until then).