Skip to main content
PATCH
/
users
/
{id-or-identifier}
Change the status of a user
curl --request PATCH \
  --url http://localhost:{port}/users/{id-or-identifier} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "status": "inactive",
  "review_comment": "User is suspended due to abuse of the system."
}
'
{
  "id": "d4add56e-c345-4ac9-b392-7a890a60559a",
  "identifier": "ben",
  "name": "Benjamin Zhang",
  "email": "[email protected]",
  "user_type": "saas_admin",
  "status": "active",
  "created_at": "2023-05-06T00:00:00Z",
  "updated_at": "2023-05-06T00:00:00Z",
  "created_by": "98d91cd7-860d-4869-937a-5af32eff2f4a",
  "updated_by": "98d91cd7-860d-4869-937a-5af32eff2f4a"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

​
X-API-Version
enum<string>
default:v1

Your API version

Available options:
v1
​
Content-Type
enum<string>
Available options:
application/json,
application/xml,
application/x-www-form-urlencoded,
application/octet-stream,
application/pdf,
text/plain,
text/html,
multipart/form-data

Path Parameters

​
id-or-identifier
string
required

Body

application/json
​
status
enum<string>
required
Available options:
active,
onboarding,
inactive,
suspended,
risky
Example:

"inactive"

​
review_comment
string
Example:

"User is suspended due to abuse of the system."

Response

Success

​
id
string<uuid>
required
Example:

"98d91cd7-860d-4869-937a-5af32eff2f4a"

​
identifier
string
required
Example:

"delay"

​
name
string
required
Example:

"Delay Technologies"

​
workspace_type
enum<string>
required
Available options:
single_user,
multi_user
Example:

"multi_user"

​
created_at
string<date-time>
required
​
updated_at
string<date-time>
required
​
owner_id
string<uuid>
Example:

"3fa85f64-5717-4562-b3fc-2c963f66afa6"

​
domain_name
string
​
created_by
string<uuid>

REQUIRE metadata permissions

Example:

"98d91cd7-860d-4869-937a-5af32eff2f4a"

​
updated_by
string<uuid>

REQUIRE metadata permissions

Example:

"98d91cd7-860d-4869-937a-5af32eff2f4a"