updateUser

PATCH

/api/v1/users/{userId}

curl --request PATCH \
  --url https://example.com/api/v1/users/example \
  --header 'Content-Type: application/json' \
  --data '{ "disabled": true, "name": "example", "role": "viewer" }'

Parameters

Path Parameters

userId

required

string

Request Body^required

Media typeapplication/json

object

disabled

boolean

name

string

<= 200 characters

role

string

Allowed values: viewer operator editor admin

key

additional properties

any

Responses

200

OK

Media typeapplication/json

object

created_at

required

string format: date-time

disabled

required

boolean

email

required

string

id

required

string

last_login_at

string format: date-time

must_change_password

required

boolean

name

required

string

role

required

string

Allowed values: viewer operator editor admin

key

additional properties

any

Example

{
  "role": "viewer"
}

default

Error

Media typeapplication/json

object

error

required

object

code

required

string

details

message

required

string

key

additional properties

any

key

additional properties

any

Example^generated

{
  "error": {
    "code": "example",
    "details": "example",
    "message": "example"
  }
}