Create a user

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

• ORG_ADMIN

POST /api/scim/v2/Users

cURL

cURL

curl --request POST \
  --url https://cockroachlabs.cloud/api/scim/v2/Users \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN' \
  --json '{"active":true,"displayName":"Carl Roach","emails":[{"primary":true,"type":"work","value":"[e-mail]"}],"externalId":"11ujl29u0le5T6Aj10h9","name":{"familyName":"Roach","givenName":"Carl"},"schemas":["urn:ietf:params:scim:schemas:core:2.0:User"],"userName":"[e-mail]"}'

200

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

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

active · boolean · required

displayName · string · required

emails · object[] · required

Show child attributes

name · name · object · required

Show child attributes

externalId · string

schemas · string[]

userName · string

Response

200

application/json

A successful response.

active · boolean

displayName · string

emails · object[]

Show child attributes

externalId · string

groups · SCIM · object[]

Show child attributes

id · string

meta · meta · object

Show child attributes

name · name · object

Show child attributes

schemas · string[]

userName · string