PHphilterd
Users

Deactivate a user.

Changed on

Deactivates a user: the user's API keys stop working, and the user and all of its data are retained so it can be reactivated. The last active administrator, and the calling administrator, cannot be deactivated. Requires an administrator as well as the scope. Recorded as a user_deactivated audit event naming the calling administrator as the principal and the calling API key in the details. Requires the users:write scope.

post/api/users/{username}/deactivate

Request

  • Base URL
    / (relative, and the document was published on a file host, not at the API’s origin)
  • URL
    /api/users/{username}/deactivate
  • Auth
    HTTP bearer

Path parameters

usernamestring required

Headers

Authorizationstring required

Response

The user was deactivated.

emailstring
activeboolean
createdstring date-time
deactivatedAtstring date-time
idstring

The user's id, which audit events and other records refer to the user by.

mfaEnabledboolean

Whether the user is enrolled in TOTP multi-factor authentication. The secret is never returned.

mfaLockedboolean

Whether the user's MFA is locked after repeated bad codes, until an administrator unlocks it.

passwordChangeRequiredboolean

Whether the user must change their password at next sign-in, because an administrator set it.

passwordSetboolean

Whether the user has a password. A user without one can only use API keys.

rolestring
usernamestring

Changes

  • c4f85daa9208Revision changes
    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

  • 99428fb4cd2dRevision changes
    • info

      added the optional property to the response with the status