List Users

Can be used by the following roles assigned at the organization scope:

• ORG_ADMIN

GET /api/scim/v2/Users

cURL

cURL

curl --request GET \
  --url https://cockroachlabs.cloud/api/scim/v2/Users \
  --header 'Authorization: Bearer <token>'

200

{
  "Resources": [
    {
      "active": true,
      "displayName": "<string>",
      "emails": [
        {
          "primary": true,
          "value": "<string>",
          "display": "<string>",
          "type": "<string>"
        }
      ],
      "externalId": "<string>",
      "groups": [
        {
          "display": "<string>",
          "ref": "<string>",
          "type": "<string>",
          "value": "<string>"
        }
      ],
      "id": "<string>",
      "meta": {
        "created": "<string>",
        "lastModified": "<string>",
        "location": "<string>",
        "resourceType": "<string>"
      },
      "name": {
        "familyName": "<string>",
        "givenName": "<string>"
      },
      "schemas": [
        "<string>"
      ],
      "userName": "<string>"
    }
  ],
  "schemas": [
    "<string>"
  ],
  "totalResults": 123
}

{
  "code": 123,
  "details": [
    {
      "@type": "<string>"
    }
  ],
  "message": "<string>"
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

filter · string

attributes · string

excludedAttributes · string

Response

200

application/json

A successful response.

Resources · object[]

Show child attributes

schemas · string[]

totalResults · integer<int32>