Skip to content
Authrim

Overview

SCIM 2.0 user and group provisioning API.

Authrim SCIM API 0.5.0

Section titled “Authrim SCIM API 0.5.0”

Initial OpenAPI contract for the SCIM 2.0 endpoints implemented by @authrim/ar-management. SCIM resource schemas are represented at a high level here; detailed semantics are governed by RFC 7643, RFC 7644, and the implementation tests. When coordinated SAML DR export is enabled, every operation can additionally return HTTP 503 while source updates are paused or update admission is unavailable. This availability response has Content-Type text/plain;charset=UTF-8, Cache-Control no-store, Retry-After 5, and the body “Service temporarily unavailable” (no response body for HEAD). Clients may retry after the indicated delay; a failed response does not establish whether an earlier write completed.

Information

  • OpenAPI version: 3.2.0

Operations

Section titled “ Operations ”
GET
/scim/v2/ServiceProviderConfig
GET
/scim/v2/ResourceTypes
GET
/scim/v2/ResourceTypes/{name}
GET
/scim/v2/Schemas
GET
/scim/v2/Schemas/{id}
GET
/scim/v2/Users
POST
/scim/v2/Users
GET
/scim/v2/Operations/{id}
GET
/scim/v2/Users/{id}
PUT
/scim/v2/Users/{id}
DELETE
/scim/v2/Users/{id}
PATCH
/scim/v2/Users/{id}
GET
/scim/v2/Groups
POST
/scim/v2/Groups
GET
/scim/v2/Groups/{id}
PUT
/scim/v2/Groups/{id}
DELETE
/scim/v2/Groups/{id}
PATCH
/scim/v2/Groups/{id}
POST
/scim/v2/Bulk

Authentication

Section titled “ Authentication ”

scimBearer

Section titled “scimBearer ”

SCIM bearer token issued by Admin SCIM token management.

Security scheme type: http