Search Users

Similar to GetUsers however search parameters are passed via the POST body. See https://www.rfc-editor.org/rfc/rfc7644.html#section-3.4.3 for more details.

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

• ORG_ADMIN

POST /api/scim/v2/Users/.search

cURL

cURL

curl --request POST \
  --url https://cockroachlabs.cloud/api/scim/v2/Users/.search \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "attributes": "<string>",
  "count": 123,
  "excludedAttributes": "<string>",
  "filter": "<string>",
  "startIndex": 123
}
'

200

{
  "schemas": [
    "<string>"
  ],
  "totalResults": 123,
  "Resources": [
    {
      "id": "<string>",
      "schemas": [
        "<string>"
      ],
      "active": true,
      "displayName": "<string>",
      "emails": [
        {
          "value": "<string>",
          "display": "<string>",
          "primary": true,
          "type": "<string>"
        }
      ],
      "externalId": "<string>",
      "groups": [
        {
          "display": "<string>",
          "ref": "<string>",
          "type": "<string>",
          "value": "<string>"
        }
      ],
      "meta": {
        "created": "<string>",
        "lastModified": "<string>",
        "location": "<string>",
        "resourceType": "<string>"
      },
      "name": {
        "familyName": "<string>",
        "givenName": "<string>"
      },
      "userName": "<string>"
    }
  ],
  "itemsPerPage": 123,
  "startIndex": 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.

Body

application/json

attributes · string

count · integer<int32>

The maximum number of resources to return. If omitted, defaults to 20. If set to 0, the response will contain no resources but will include metadata such as totalResults, complying with RFC 7644, Section 3.4.2.4: Pagination.

excludedAttributes · string

filter · string

startIndex · integer<int32>

The 1-based index of the first resource to return in the response. If omitted or less than 1, defaults to 1. This behavior complies with RFC 7644, Section 3.4.2.4: Pagination.

Response

200

application/json

A successful response.

schemas · string[] · required

totalResults · integer<int32> · required

Resources · ScimUser · object[]

Show child attributes

itemsPerPage · integer<int32>

startIndex · integer<int32>