Users
User Preferences

Getting authenticated User details

Changed on

Typically, you would get User details by the User's numeric Actor ID.

However, if you only have a Bearer token, for example, you don't have any information about the user attached to that session, including even the ID with which to get more information. So you can instead supply the text current to get the user information associated with the authenticated session.

If you do use current, you may request extended metadata. Supply an X-Extended-Metadata header value of true to additionally receive:

  • an array of strings of the verbs the authenticated User/Actor is allowed to perform server-wide
  • an object containing the preferences of the authenticated User/Actor
get/v1/users/current

Request

  • Base URL
    / (relative, and the document was published on a file host, not at the API’s origin)
  • URL
    /v1/users/current
  • Auth
    none declared

Response

This is the Extended Metadata response, if requested via the appropriate header:

createdAtstring

ISO date format

displayNamestring

All Actors, regardless of type, have a display name

idnumber
type'user' | 'field_key' | 'public_link' | 'singleUse'

the Type of this Actor; typically this will be user.

updatedAtstring

ISO date format

deletedAtstring

ISO date format

emailstring

Only Users have email addresses associated with them

Changes