Identity

Get Me

Changed on

Return the caller's identity and context, discriminated by actor type.

get/me

Request

  • Base URL: / (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /me
  • Auth: one of:
    • HTTP bearer
    • OAuth 2 (authorization code, authorization URL /authorize, token URL /oauth/token)

Response

Successful Response

OR

Example response

{
  "admin": true,
  "email": "ada@example.com",
  "id": "usr_6968b3987ee4c3ec0b4ee3b9",
  "must_change_password": false,
  "name": "Ada Lovelace",
  "permissions": [
    "org:admin",
    "agents:read"
  ],
  "status": "active",
  "type": "user"
}

Changes

  • c516481e6ed8Revision changes
    • info

      the endpoint scheme security OAuth2 was added to the API

  • 7bc6dc51d87fRevision changes
    • breaking

      removed the required property / from the response with the status

    • breaking

      removed the required property / from the response with the status

    • breaking

      removed the required property / from the response with the status

    • info

      added the required property / to the response with the status

    • info

      added the required property / to the response with the status

    • info

      added the required property / to the response with the status