Skip to content
Logo

api.auth.me

Whoami for the user behind the credential: full profile, every org they belong to, MFA state. The single canonical "who am I" call.

const  = await ..();
 
for (const  of .) {
  .(`${.} at ${.}`);
}
 
// `mfa_passed` reflects the current session: `true` for `Api-Key` calls,
// or `true` for token sessions that have completed the MFA flow.
if (!.) {
  // step-up the user via MFA before any sensitive action
}

Arguments: none.

Returns: Promise<UserProfile>. Fields documented under GET /auth/me.

REST endpoint: GET /auth/me.