Skip to main content
PATCH
/
api
/
svc
/
v1
/
users
/
deactivate
Deactivate a user
curl --request PATCH \
  --url https://{controlPlaneURL}/api/svc/v1/users/deactivate \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "email": "user@example.com",
  "tenantName": "<string>"
}
'
{}

Authorizations

​
Authorization
string
header
required

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

Body

application/json
​
email
string
required

Email of the user to deactivate.

Example:

"user@example.com"

​
tenantName
string | null

Tenant name override. Defaults to the caller's tenant when omitted.

Response

The user has been deactivated.

The response is of type DeactivateUserResponse · object.