Suspend or reactivate a user

POST

/v1/users/{id}/suspend

curl --request POST \
  --url https://example.com/v1/users/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/suspend \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-Tenant-ID: 2489E9AD-2EE2-8E00-8EC9-32D5F69181C0' \
  --data '{ "active": true }'

Authorizations

• BearerAuth

Parameters

Path Parameters

id

required

string format: uuid

Header Parameters

X-Tenant-ID

required

string format: uuid

Tenant identifier. Must match the tenant associated with the credential. Returns 403 tenant_mismatch if the credential and header belong to different tenants.

Request Body ^required

Media type application/json

object

active

required

boolean

Example ^generated

{
  "active": true
}

Responses

200

OK

Media type application/json

object

id

required

string format: uuid

email

required

string

name

required

string

roles

required

Array<string>

auth_provider

required

string

Allowed values: local oidc saml

active

required

boolean

email_verified

required

boolean

is_owner

required

Whether this user is the tenant owner.

boolean

created_at

required

string format: date-time

updated_at

required

string format: date-time

avatar_base64

Base64-encoded image data with data URI prefix (max ~256KB)

string

nullable

Example

{
  "auth_provider": "local"
}

401

Unauthenticated

Media type application/json

object

code

required

Machine-readable error code (e.g. “not_found”, “tenant_mismatch”).

string

message

required

Human-readable description of the error.

string

details

Optional additional context about the error.

object

key

additional properties

any

notices

Policy notices from determining Cedar rules, if applicable.

Array<string>

Example ^generated

{
  "code": "example",
  "message": "example",
  "details": {},
  "notices": [
    "example"
  ]
}

404

Not found

Media type application/json

object

code

required

Machine-readable error code (e.g. “not_found”, “tenant_mismatch”).

string

message

required

Human-readable description of the error.

string

details

Optional additional context about the error.

object

key

additional properties

any

notices

Policy notices from determining Cedar rules, if applicable.

Array<string>

Example ^generated

{
  "code": "example",
  "message": "example",
  "details": {},
  "notices": [
    "example"
  ]
}