v1

latestOpenAPI 3.0.02026-08-064311,0881.3 MB

scimUserManagement

List SCIM Users

Retrieves a list of users in the SCIM system, with optional pagination

get/v1/scim/Users

Query parameters

startIndexinteger

The index of the first result to return. Defaults to 1 if not specified, a value less than 1 SHALL be interpreted as 1

countinteger

The maximum number of results to return. Defaults to 100

filterstring

Example:emails.value eq "john@doe.com"

Find user with the given email address

sortOrder'ascending' | 'descending'

Example:descending

The sort order. Use "ascending" or "descending"

sortBystring

Example:givenName

Sort the list of users by the givenName, familyName, or emails field

Response

A paginated list of users in the organization

totalResultsinteger

Total number of users that match the filter criteria

startIndexinteger

The index of the first returned result

itemsPerPageinteger

The number of results returned in this page

Example response

{
  "totalResults": 100,
  "itemsPerPage": 10,
  "Resources": [
    {
      "schemas": [
        "urn:ietf:params:scim:schemas:core:2.0:User"
      ],
      "userName": "jdoe@example.com",
      "name": {
        "givenName": "John",
        "familyName": "Doe"
      },
      "emails": [
        {
          "value": "jdoe@example.com",
          "type": "work",
          "primary": true
        }
      ],
      "roles": [
        [
          "role1",
          "role2"
        ],
        [
          {
            "value": "role1",
            "primary": true
          },
          {
            "value": "role2",
            "primary": true
          }
        ]
      ],
      "id": "000000000FE20FE2",
      "active": true,
      "meta": {
        "resourceType": "User",
        "created": "2024-01-01T12:00:00Z",
        "lastModified": "2024-01-01T12:00:00Z"
      }
    }
  ]
}