Get the currently authenticated user

Prev Next
Get
/auth/me

Returns information about the currently logged-in user.

This endpoint is useful for front-end apps to confirm who is signed in and what permissions they have. It relies on the auth-token cookie set by /auth/login.

Security
API Key: CookieAuth
Cookie parameter nameauth-token

Authentication is handled via an auth-token HTTP-only cookie set by the /auth/login endpoint.

  • In a browser, you typically call /auth/login once and the cookie will be stored and automatically sent on subsequent API requests.
  • In API tools (Postman, curl, etc.) you can manually capture the cookie from the Set-Cookie header or configure cookie handling.

This spec models the cookie using apiKey-style auth for documentation purposes.

Responses
200

Authenticated user details.

Expand All
object

Envelope used by /auth/me to return the current user.

user
object (User)

Basic user information for the currently authenticated user.

id
string

Internal user identifier.

email
string (email)
name
string | null
role
string

High-level role for permissions (e.g., ADMIN, EDITOR, VIEWER).

disabled
boolean

Whether the account is disabled.

permissions
object | null

Fine-grained permission map used internally.

property*
Array of string additionalProperties
string
401

No valid auth cookie was provided.

object

Standard error response envelope.

Example{ "error": "Failed to load agents. Please try again." }
error
string

Human-readable error message.

403

The user account is disabled.

object

Standard error response envelope.

Example{ "error": "Failed to load agents. Please try again." }
error
string

Human-readable error message.

404

The user referenced by the token no longer exists.

object

Standard error response envelope.

Example{ "error": "Failed to load agents. Please try again." }
error
string

Human-readable error message.

500

Unexpected server error.

object

Standard error response envelope.

Example{ "error": "Failed to load agents. Please try again." }
error
string

Human-readable error message.