Sign in
Users
User Preferences

Getting authenticated User details

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

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

Changed in 3 of the 54 revisions of this API.4

  • 022694254f0d1See the full diff
    • ○

      api operation id Getting authenticated User details removed and replaced with getAuthenticatedUserDetails

      api-operation-id-removed

  • b11b54eea4871See the full diff
    • ○

      removed the non-success response with the status 403

      response-non-success-status-removed

  • e8c2858fd4eb2See the full diff
    • ○

      api operation id getAuthenticatedUserDetails removed and replaced with Getting authenticated User details

      api-operation-id-removed

    • ○

      added the non-success response with the status 403

      response-non-success-status-added

    This revision also has 11 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog