Get Me - Xagent

Get Me

curl --request GET \
  --url https://api.example.com/v1/me \
  --header 'Authorization: Bearer <token>'

{
  "user_id": 123,
  "username": "<string>",
  "key_prefix": "<string>",
  "principal_type": "user",
  "email": "<string>"
}

GET

Get Me

curl --request GET \
  --url https://api.example.com/v1/me \
  --header 'Authorization: Bearer <token>'

{
  "user_id": 123,
  "username": "<string>",
  "key_prefix": "<string>",
  "principal_type": "user",
  "email": "<string>"
}

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

200 - application/json

Successful Response

Response model for GET /v1/me.

user_id

integer

required

User bound to the presented personal key.

username

string

required

User's unique login name.

key_prefix

string

required

Public-safe 6-char lookup handle of the presented key. Lets the SDK log which key is in use without exposing the secret.

principal_type

string

default:user

Authenticated principal.

string | null

User's email address, or null if unset.