DOdomain
Me

Retrieve information about the currently authorised request

get/v1/me

Request

  • Base URL
    https://api.domain.com.au
  • Auth
    • API key in header x-api-key
    • or OAuth 2
      Authorization codehttps://auth.domain.com.au/v1/connect/authorize
      Client credentials
      Token URLhttps://auth.domain.com.au/v1/connect/token
  • TypeScript
    A function with typed inputs. Its response is checked against the schema.

Response

User information

authenticatedboolean

True if the current request was successfully authenticated

clientIdstring nullable

The Client ID or API Key used to authenticated this request

subjectIdstring nullable

A unique user id, only if this request is authenticated as a user context.

subjectEmailstring nullable

The users email address if available

Changes

No recorded changes to this operation across all 18 revisions of this API.