PHphilterd
Users

Get the calling key's user.

Changed on

Returns the user that owns the API key making the request, with whether this deployment makes MFA available and required. Does not require an administrator. Requires the users:read scope.

get/api/users/me

Request

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

Headers

Authorizationstring required

Response

The calling key's user.

emailstring
activeboolean
createdstring date-time
deactivatedAtstring date-time
idstring

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

mfaAvailableboolean

Whether this deployment lets users enroll in MFA.

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.

mfaRequiredboolean

Whether this deployment makes every user who signs in enroll in MFA. Never true while mfaAvailable is false.

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 non-success 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