Skip to content

SCIM API Reference ​

GET /scim/v2/Groups ​

Report unsupported SCIM Groups

Groups are not provisioned by this service. ResourceTypes lists User only; this endpoint returns a SCIM 501 error. The static SCIM bearer token is required.

Responses ​

  • 200 — Successful response

Errors ​

StatusCodeDetail
401a valid SCIM bearer token is requiredUnauthorized
501SCIM Groups provisioning is not supportedNot Implemented

GET /scim/v2/ResourceTypes ​

List supported SCIM resource types

Lists User as the only supported resource type. Groups provisioning is unsupported and GET /scim/v2/Groups returns 501. The static SCIM bearer token is required.

Responses ​

  • 200 — Successful response
json
{
  "Resources": [
    {
      "endpoint": "/Users",
      "id": "User",
      "meta": {
        "resourceType": "ResourceType"
      },
      "name": "User",
      "schema": "urn:ietf:params:scim:schemas:core:2.0:User",
      "schemas": [
        "urn:ietf:params:scim:schemas:core:2.0:ResourceType"
      ]
    }
  ],
  "itemsPerPage": 1,
  "schemas": [
    "urn:ietf:params:scim:api:messages:2.0:ListResponse"
  ],
  "startIndex": 1,
  "totalResults": 1
}

Errors ​

StatusCodeDetail
401a valid SCIM bearer token is requiredUnauthorized

GET /scim/v2/ServiceProviderConfig ​

Read SCIM service capabilities

Returns supported SCIM features. PATCH add/remove/replace operations for supported user attributes, including structured name sub-attributes, and userName equality filtering are supported; full user replacement is available with PUT. Bulk and sort are not supported. The static SCIM bearer token is required.

Responses ​

  • 200 — Successful response
json
{
  "authenticationSchemes": [
    {
      "description": "Static bearer token authentication",
      "name": "SCIM Bearer Token",
      "primary": true,
      "specUri": "https://www.rfc-editor.org/rfc/rfc6750",
      "type": "oauthbearertoken"
    }
  ],
  "bulk": {
    "supported": false
  },
  "changePassword": {
    "supported": false
  },
  "etag": {
    "supported": false
  },
  "filter": {
    "maxResults": 1000,
    "supported": true
  },
  "patch": {
    "supported": true
  },
  "schemas": [
    "urn:ietf:params:scim:schemas:core:2.0:ServiceProviderConfig"
  ],
  "sort": {
    "supported": false
  }
}

Errors ​

StatusCodeDetail
401a valid SCIM bearer token is requiredUnauthorized

GET /scim/v2/Users ​

List SCIM users

Lists only externally identified users eligible for SCIM management, excluding erased users, service accounts, and users with effective IAM permissions. Uses SCIM startIndex/count pagination (startIndex is one-based; count defaults to 100 and may be zero). The only filter is userName eq "value"; count is capped at 1000. Invalid pagination and unsupported sort parameters return 400. Responses use application/scim+json and require the static SCIM bearer token.

Responses ​

  • 200 — Successful response
json
{
  "Resources": [
    {
      "active": true,
      "id": "01J8Z3USER000000000000001",
      "schemas": [
        "urn:ietf:params:scim:schemas:core:2.0:User"
      ],
      "userName": "alice"
    }
  ],
  "itemsPerPage": 1,
  "schemas": [
    "urn:ietf:params:scim:api:messages:2.0:ListResponse"
  ],
  "startIndex": 1,
  "totalResults": 1
}

Errors ​

StatusCodeDetail
400only a userName eq string filter is supportedInvalid Filter
401a valid SCIM bearer token is requiredUnauthorized
500the SCIM request could not be completedInternal Server Error

POST /scim/v2/Users ​

Create a SCIM user

Creates a user from userName, externalId, name/displayName, emails, and active. The schemas array must contain the core User schema URN. A non-empty externalId and userName are required. name.givenName and name.familyName are persisted and returned as a structured name with formatted derived from displayName. A supplied email must be a valid address and unique. A duplicate userName, externalId, or email returns 409. Include Idempotency-Key to replay a successful retry. The request and response use application/scim+json; the static SCIM bearer token is required.

Request body (application/json) ​

FieldTypeRequired
activebooleanNo
displayNamestringNo
emailsarray<object>No
externalIdstringNo
namenullNo
schemasarray<string>No
userNamestringYes
json
{
  "active": true,
  "emails": [
    {
      "primary": true,
      "value": "alice@example.test"
    }
  ],
  "externalId": "directory-123",
  "name": {
    "familyName": "Example",
    "givenName": "Alice"
  },
  "schemas": [
    "urn:ietf:params:scim:schemas:core:2.0:User"
  ],
  "userName": "alice"
}

Responses ​

  • 200 — Successful response
json
{
  "active": true,
  "displayName": "Alice Example",
  "emails": [
    {
      "primary": true,
      "type": "work",
      "value": "alice@example.test"
    }
  ],
  "externalId": "directory-123",
  "id": "01J8Z3USER000000000000001",
  "meta": {
    "created": "2026-01-01T00:00:00Z",
    "lastModified": "2026-01-01T00:00:00Z",
    "location": "/scim/v2/Users/01J8Z3USER000000000000001",
    "resourceType": "User"
  },
  "schemas": [
    "urn:ietf:params:scim:schemas:core:2.0:User"
  ],
  "userName": "alice"
}

Errors ​

StatusCodeDetail
400the schemas array or userName/externalId is invalid, or email is invalidInvalid Value
401a valid SCIM bearer token is requiredUnauthorized
409userName, externalId, or email already existsUniqueness Conflict
415Content-Type must be application/scim+jsonUnsupported Media Type
500the SCIM request could not be completedInternal Server Error

DELETE /scim/v2/Users/{id} ​

Disable a SCIM user

Soft-deletes an eligible SCIM user by setting active to false and marking the disable as SCIM-owned so a later SCIM activation is allowed. Erased, service-account, and effective-IAM targets are protected; the user record remains readable as disabled only while it remains eligible. Sessions are revoked, permissions invalidated, lifecycle/audit records appended, and the endpoint returns no body. Repeated DELETE on an already-disabled user returns 204 without new audit or lifecycle rows. The static SCIM bearer token is required.

Path parameters ​

ParameterDescription
idPath parameter.

Responses ​

  • 204 — No Content

Errors ​

StatusCodeDetail
401a valid SCIM bearer token is requiredUnauthorized
403the SCIM target is protectedForbidden
404the requested user was not foundNot Found
500the SCIM request could not be completedInternal Server Error

GET /scim/v2/Users/{id} ​

Read a SCIM user

Returns one SCIM User by the service-issued id. The name attribute is a structured object with formatted, givenName, and familyName so values round-trip losslessly; formatted always matches displayName. Users without externalId, erased users, service accounts, and users with effective IAM permissions are reported as not found. The response uses application/scim+json and requires the static SCIM bearer token.

Path parameters ​

ParameterDescription
idPath parameter.

Responses ​

  • 200 — Successful response

Errors ​

StatusCodeDetail
401a valid SCIM bearer token is requiredUnauthorized
404the requested user was not foundNot Found
500the SCIM request could not be completedInternal Server Error

PATCH /scim/v2/Users/{id} ​

Update a SCIM user

Applies RFC 7644 add/remove/replace operations for active, name (including dotted name.formatted, name.givenName, and name.familyName paths and pathless attribute keys), displayName, and emails, including filtered paths such as emails[type eq "work"].value. The schemas array must contain the PatchOp URN. Changed emails must be valid and unique. Service accounts and users with effective IAM permissions remain protected. Only users disabled through SCIM can be activated; administrators disabling a user clear the SCIM marker, so admin-disabled, pending, and invited users return 403 with a mutability hint. No-op operations are accepted without appending audit or lifecycle rows. The request and response use application/scim+json; the static SCIM bearer token is required.

Path parameters ​

ParameterDescription
idPath parameter.

Request body (application/json) ​

FieldTypeRequired
Operationsarray<object>Yes
schemasarray<string>No
json
{
  "operations": [
    {
      "op": "replace",
      "path": "active",
      "value": false
    },
    {
      "op": "add",
      "path": "emails[type eq \"work\"].value",
      "value": "alice@example.test"
    }
  ],
  "schemas": [
    "urn:ietf:params:scim:api:messages:2.0:PatchOp"
  ]
}

Responses ​

  • 200 — Successful response

Errors ​

StatusCodeDetail
400the schemas array, PATCH path, or value is invalid, or the email address is invalidInvalid Patch
401a valid SCIM bearer token is requiredUnauthorized
403the SCIM target is protected or cannot be activatedForbidden
404the requested user was not foundNot Found
409email is already in useUniqueness Conflict
415Content-Type must be application/scim+jsonUnsupported Media Type
500the SCIM request could not be completedInternal Server Error

PUT /scim/v2/Users/{id} ​

Replace a SCIM user

Replaces the SCIM user's writable profile fields. The schemas array must contain the core User schema URN. userName is required; omitted displayName, name sub-attributes, and emails are cleared, and active defaults to true unless explicitly false. A non-empty externalId replaces the client-owned identifier; if omitted it is preserved and it cannot be cleared. Email values must be valid and unique. Only eligible users without effective IAM permissions or service credentials may be changed. Activation is allowed only for users disabled through SCIM (scim_disabled); administrators disabling a user clear that marker, so admin-disabled and pending or invited users cannot be activated through SCIM.

Path parameters ​

ParameterDescription
idPath parameter.

Request body (application/json) ​

FieldTypeRequired
activebooleanNo
displayNamestringNo
emailsarray<object>No
externalIdstringNo
namenullNo
schemasarray<string>No
userNamestringYes
json
{
  "active": true,
  "emails": [
    {
      "primary": true,
      "type": "work",
      "value": "alice@example.test"
    }
  ],
  "externalId": "directory-123",
  "userName": "alice"
}

Responses ​

  • 200 — Successful response

Errors ​

StatusCodeDetail
400the schemas array, userName, externalId, or email is invalidInvalid Value
401a valid SCIM bearer token is requiredUnauthorized
403the SCIM target is protected or cannot be activatedForbidden
404the requested user was not foundNot Found
409userName, externalId, or email already existsUniqueness Conflict
415Content-Type must be application/scim+jsonUnsupported Media Type
500the SCIM request could not be completedInternal Server Error