Search for a user by ID

Similar to GetUser 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/{id}/.search

cURL

cURL

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

200

{
  "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>"
}

{
  "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.

Path Parameters

id · string · required

Body

application/json

attributes · string

excludedAttributes · string

Response

200

application/json

A successful response.

SCIM 2.0 User Resource

id · string · required

schemas · string[] · required

active · boolean

displayName · string

emails · object[]

Show child attributes

externalId · string

groups · SCIM · object[]

Show child attributes

meta · meta · object

Show child attributes

name · name · object

Show child attributes

userName · string