auth

get user

Changed on
get/auth/users/{userId}

Request

  • Base URL
    /api/v1 (relative, and the document was published on a file host, not at the API’s origin)
  • URL
    /api/v1/auth/users/{userId}
  • Auth
    • HTTP bearer
    • or HTTP basic
    • or API key in cookie internal_auth_session

Response

user

idstring required

A unique identifier for the user. Cannot be edited.

creation_dateinteger required

Unix Epoch in seconds

friendly_namestring

A shorter name for the user than the id. Unlike id it does not identify the user (it might not be unique). Used in some places in the UI.

emailstring

The email address of the user. If API authentication is enabled, this field is mandatory and will be invited to login. If API authentication is disabled, this field will be ignored. All current APIAuthenticators require the email to be lowercase and unique, although custom authenticators may not enforce this.

Changes