Replace user

Update a user by ID (SCIM PUT)

PUT /api/v1/scim/v2/Users/{userUuid}

Error

A valid request URL is required to generate request examples

200

{
  "schemas": [
    "<string>"
  ],
  "id": "<string>",
  "userName": "<string>",
  "meta": {
    "version": "<string>",
    "location": "<string>",
    "lastModified": "2023-11-07T05:31:56Z",
    "created": "2023-11-07T05:31:56Z",
    "resourceType": "<string>"
  },
  "name": {
    "familyName": "<string>",
    "givenName": "<string>"
  },
  "active": true,
  "emails": [
    {
      "value": "<string>",
      "primary": true
    }
  ],
  "roles": [
    {
      "value": "<string>",
      "display": "<string>",
      "type": "<string>",
      "primary": true
    }
  ],
  "urn:lightdash:params:scim:schemas:extension:2.0:User": {
    "role": "<string>"
  }
}

Path Parameters

userUuid · string · required

UUID of the user to update

Body

application/json

Updated user data

Updated user data

schemas · string[] · required

userName · string · required

urn:lightdash:params:scim:schemas:extension:2.0:User · object

Show child attributes

name · object

Show child attributes

active · boolean

emails · object[]

Show child attributes

roles · object[]

Show child attributes

meta · object

Show child attributes

title · string

password · string

Response

200

application/json

Ok

schemas · string[] · required

id · string · required

userName · string · required

meta · object

Show child attributes

name · object

Show child attributes

active · boolean

emails · object[]

Show child attributes

roles · object[]

Show child attributes

urn:lightdash:params:scim:schemas:extension:2.0:User · object

Show child attributes