SCIM 2.0 Provisioning

Automate user provisioning and deprovisioning using SCIM 2.0.

Base URL

~~~ https://api.buttrbase.com/scim/v2/organizations/:org_uuid ~~~

Authentication

Include your SCIM token in the Authorization header:

~~~ Authorization: Bearer scim_token_... ~~~

Generate a SCIM token from the ButtrBase admin dashboard.

Users

GET /scim/v2/organizations/:org_uuid/Users

Lists users in the organization (SCIM format).

POST /scim/v2/organizations/:org_uuid/Users

Creates a new user.

Input (SCIM User): ~~~json { "schemas": ["urn:ietf:params:scim:schemas:core:2.0:User"], "userName": "alice@acme.com", "name": { "givenName": "Alice", "familyName": "Smith" }, "emails": [{ "value": "alice@acme.com", "primary": true }], "active": true } ~~~

PATCH /scim/v2/organizations/:org_uuid/Users/:id

Updates a user (supports deprovisioning via active: false).

DELETE /scim/v2/organizations/:org_uuid/Users/:id

Deprovisions a user.

Groups

GET /scim/v2/organizations/:org_uuid/Groups

Lists teams as SCIM groups.

POST /scim/v2/organizations/:org_uuid/Groups

Creates a team.

Error Reference

| Status | Code | Meaning | |--------|------|---------| | 400 | validation_error | Request body failed validation | | 401 | unauthorized | Missing or invalid Authorization header | | 403 | forbidden | Insufficient permissions | | 404 | not_found | Resource does not exist | | 409 | conflict | Resource already exists or constraint violated | | 422 | unprocessable | Semantic validation failure | | 429 | rate_limited | Request rate exceeded | | 500 | internal_error | Unexpected server error |