Setup
2
Configure your identity provider
Point your IdP’s SCIM provisioning settings at:SCIM_TOKEN exactly. Use a long random secret (32+ bytes). The /api/theauth part of the base URL is the default adapter mount path, so it follows wherever you mounted the adapter.Optional config: autoCreateUsers (default true), autoDeactivateUsers (default true), onProvision(user) and onDeprovision(userId) callbacks.User endpoints
The plugin exposes SCIM 2.0 user CRUD endpoints. Your IdP calls these automatically. Users map to theAuth’s users table.
Deprovisioning (
DELETE, or active: false in a PUT or PATCH) deactivates the user by setting their banned flag and a scim:deprovisioned metadata marker when autoDeactivateUsers is on. With it off, DELETE removes the user row. theAuth’s sign-in modules do not check the banned flag, so check it in your own sign-in flow (see Admin) for deprovisioning to cut off access.
Group endpoints
Groups are mapped to theAuth organizations.Filtering and sorting
The Users and Groups list endpoints accept the full RFC 7644 filter grammar through thefilter query parameter:
eq, ne, co, sw, ew, gt, ge, lt, le and pr, combined with and, or, not and parentheses, plus value path selectors. A filter that does not parse returns 400 invalidFilter. See the filter reference for the grammar.
List endpoints also accept sortBy and sortOrder, with id as the tie break, along with startIndex and count for pagination.
PATCH
PATCH supports path expressions with value filters, such asemails[type eq "work"].value, and rejects changes to immutable attributes with 400 mutability. A single request is capped at 1000 operations. See the PATCH reference.
Me and Bulk
GET /scim/v2/Me is opt in. Pass a resolveSelf callback to map the authenticated caller to a SCIM user, otherwise the endpoint returns 501. POST /scim/v2/Bulk returns a spec compliant 501, and ServiceProviderConfig advertises bulk as unsupported.
Enterprise User extension
User resources accept and return the RFC 7643 Enterprise User extension (employeeNumber, department, manager and the rest). It is advertised in /Schemas.
Audit
Passaudit: { agentId } to record an audit log row for every successful provisioning write (POST, PUT, PATCH and DELETE). The agent must already exist. Audit writes are best effort, so a failed audit insert never fails the SCIM call.
Discovery endpoints
SCIM clients use these to learn what your server supports:Related
Organizations
SCIM groups are mapped to theAuth organizations.
SSO
Enterprise SSO via SAML 2.0 and OIDC, often paired with SCIM.
Admin
Manual user management tools alongside automated provisioning.
Authentication overview
All sign-in methods available in theAuth.