Delete a user

curl --request DELETE \
  --url https://{controlPlaneURL}/api/svc/v1/users/{id} \
  --header 'Authorization: Bearer <token>'

{}

DELETE

api

svc

users

{id}

Delete a user

curl --request DELETE \
  --url https://{controlPlaneURL}/api/svc/v1/users/{id} \
  --header 'Authorization: Bearer <token>'

{}

Authorization

string

header

required

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

string

required

System-generated user ID.

Example:

"jqfwg345gi25n5ju2yz5iz6m"

tenantName

string | null

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

The user has been deleted.

The response is of type DeleteUserResponse · object.

⌘I