Skip to main content
PATCH
/
api
/
v1
/
scim
/
v2
/
Users
/
{userUuid}
Patch user
curl --request PATCH \
  --url http://api/v1/scim/v2/Users/{userUuid} \
  --header 'Content-Type: application/json' \
  --data '
{
  "schemas": [
    "urn:ietf:params:scim:api:messages:2.0:PatchOp"
  ],
  "Operations": [
    {
      "op": "remove",
      "path": "<string>",
      "value": "<any>"
    }
  ]
}
'
{
  "schemas": [
    "<string>"
  ],
  "id": "<string>",
  "meta": {
    "version": "<string>",
    "location": "<string>",
    "lastModified": "2023-11-07T05:31:56Z",
    "created": "2023-11-07T05:31:56Z",
    "resourceType": "<string>"
  },
  "userName": "<string>",
  "name": {
    "familyName": "<string>",
    "givenName": "<string>"
  },
  "active": true,
  "emails": [
    {
      "primary": true,
      "value": "<string>"
    }
  ],
  "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 patch

Body

application/json

Patch operations to apply

​
schemas
enum<string>[]
required
​
Operations
object[]
required
  • Option 1
  • Option 2

Response

Ok

​
schemas
string[]
required
​
id
string
required
​
userName
string
required
​
meta
object
​
name
object
​
active
boolean
​
emails
object[]
​
roles
object[]
​
urn:lightdash:params:scim:schemas:extension:2.0:User
object