Skip to main content
GET /me returns the effective identity and access state for the current request. It works with either a browser session cookie or a personal API key, which makes it useful for verifying credentials and role-preview state.

Endpoint

Authentication: session cookie or Authorization: Bearer lsk_....

Response

string
The caller’s username.
boolean
Whether the effective identity holds the admin role. This is false while an administrator is previewing a non-admin role.
boolean
Whether the underlying authenticated actor is an administrator, including during role preview.
string
The role currently being previewed. Empty when preview is inactive.
array of strings
Roles used for the current request.
boolean
Whether the caller must change their password before other routes become available.
boolean
Whether the caller is the displayed account in a deployment with hosted demo mode enabled.

Example response

Example