Skip to main content
Manage users via SCIM 2.0 protocol.

Endpoints

List users

GET /scim/v2/Users
Response:
{
  "schemas": ["urn:ietf:params:scim:api:messages:2.0:ListResponse"],
  "totalResults": 1,
  "Resources": [
    {
      "id": "usr_1234567890",
      "userName": "[email protected]",
      "name": {
        "givenName": "John",
        "familyName": "Doe"
      },
      "emails": [
        {
          "value": "[email protected]",
          "primary": true
        }
      ],
      "active": true
    }
  ]
}

Create user

POST /scim/v2/Users
Request body:
{
  "schemas": ["urn:ietf:params:scim:schemas:core:2.0:User"],
  "userName": "[email protected]",
  "name": {
    "givenName": "John",
    "familyName": "Doe"
  },
  "emails": [
    {
      "value": "[email protected]",
      "primary": true
    }
  ],
  "active": true
}

Update user

PATCH /scim/v2/Users/{userId}

Delete user

DELETE /scim/v2/Users/{userId}

Next steps

SCIM groups

Group provisioning

Directory sync

Directory synchronization

Build docs developers (and LLMs) love