Deactivate account

Deactivates an account. The account will not have any access to the tenant anymore. You cannot deactivate your own account.

^{Required permissions: account:deactivate}

PUT /accounts/{id}/deactivate

cURL

cURL

curl -X PUT \
 /accounts/{id}/deactivate \
 --header "Authorization: Bearer <token>"

200

{
  "id": "01F9Z3ZJXZQZJZJZJZJZJZJZJZ",
  "user": "https://example.com/",
  "role": "administrator",
  "createdAt": "2023-11-07T05:31:56Z",
  "deactivated": true
}

Autorisierungen

Authorization · string · header · erforderlich

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

Pfadparameter

id · string · erforderlich

Account identifier

Antwort

200

application/json

Account resource updated

id · string · read-only

Beispiel:

"01F9Z3ZJXZQZJZJZJZJZJZJZJZ"

user · string<uuid> · read-only

Beispiel:

"https://example.com/"

role · enum<string> · Standard: administrator · read-only

Verfügbare Optionen: administrator, account, read-only

Beispiel:

"administrator"

createdAt · string<date-time>

deactivated · boolean · read-only