PHphilterd
Users

Set a user's email address.

Changed on

Sets or removes a user's email address. An address must have one @, something on each side, a dot in the domain, and no whitespace, and be at most 254 characters; a null or empty email removes it. The email address is not how a user is addressed or signs in, so changing it changes nothing else. Requires an administrator as well as the scope. Recorded as a user_email_changed audit event naming the calling administrator as the principal and the calling API key in the details; the address itself is not recorded. Requires the users:write scope.

put/api/users/{username}/email

Request

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

Path parameters

usernamestring required

Headers

Authorizationstring required

Request body

emailstring

The new email address. null or empty removes the user's email address.

Response

The email address was set or removed.

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

  • 51b359ecbb06Revision changes
    • info

      endpoint added