v1

latestOpenAPI 3.1.02026-07-242735131.1 MB

SCIM

Get user by ID via SCIM v2.0

Retrieves a single user for the authenticated company by user ID

get/v1/scim/v2/Users/{id}

Path parameters

idstring required

User ID (slug)

Response

Success

activeboolean required

Whether the user is active

departmentstring

Identifies the name of a department (Enterprise User extension)

employeeNumberstring

Numeric or alphanumeric identifier assigned to a person (Enterprise User extension)

idstring required

Unique identifier for the user

schemasstring[] required

SCIM schema identifiers

userNamestring required

Username for the user

Example response

{
  "active": true,
  "department": "Engineering",
  "emails": [
    {
      "primary": true,
      "type": "work",
      "value": "john.doe@example.com"
    }
  ],
  "employeeNumber": "EMP001",
  "id": "123456",
  "manager": {
    "displayName": "Jane Manager",
    "value": "789012"
  },
  "meta": {
    "created": "2023-01-01T00:00:00Z",
    "lastModified": "2023-01-01T00:00:00Z",
    "resourceType": "User"
  },
  "name": {
    "familyName": "Doe",
    "formatted": "John Doe",
    "givenName": "John"
  },
  "schemas": [
    "urn:ietf:params:scim:schemas:core:2.0:User",
    "urn:ietf:params:scim:schemas:extension:enterprise:2.0:User"
  ],
  "userName": "john.doe@example.com"
}