Skip to main content
PATCH
updateTenantUserStatus

Authorizations

Authorization
string
header
required

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

Headers

X-Tenant
string

Workspace slug. Overrides subdomain-based workspace resolution when provided.

Example:

"acme"

X-Request-ID
string<uuid>

Optional request correlation ID echoed back in the response.

Example:

"550e8400-e29b-41d4-a716-446655440000"

Path Parameters

userId
string
required

userId parameter UUID v4 string as base62

Body

application/json
status
enum<string>
required

The new status for the workspace user.

Available options:
PENDING,
ACTIVE,
SUSPENDED,
REVOKED

Response

Successful response

data
object
required

A user object from the point of view of a specific Workspace. Projects web-db TenantUser; joined user/role fields are @virtual.

meta
object
required