Skip to main content
GET
/
api
/
v1
/
pub
/
{project_id}
/
auth
/
me
Current user profile
curl --request GET \
  --url https://org-api.hexoforge.dev/api/v1/pub/{project_id}/auth/me \
  --header 'X-API-Key: <api-key>'
{
  "id": {},
  "email": "<string>",
  "name": {},
  "phone": {},
  "is_active": true,
  "email_verified": true,
  "totp_enabled": true,
  "metadata": {},
  "last_login_method": {},
  "roles": [
    "<string>"
  ],
  "permissions": [
    "<string>"
  ]
}

Documentation Index

Fetch the complete documentation index at: https://orchestrator-docs.hexoforge.dev/llms.txt

Use this file to discover all available pages before exploring further.

Returns the current user record. Requires X-API-Key and a valid Bearer access token.
Send both X-API-Key and Authorization: Bearer with your access token. Prefer local JWT validation with JWKS for hot paths; use this endpoint as a fallback or for testing.

Response

200 OK
{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "email": "user@example.com",
  "name": "Jane Doe",
  "phone": "+1234567890",
  "is_active": true,
  "email_verified": true,
  "totp_enabled": false,
  "metadata": { "plan": "pro" },
  "last_login_method": "email",
  "roles": ["user", "editor"],
  "permissions": ["read:posts", "write:posts"]
}
id
string (uuid)
User identifier.
email
string
Email address.
name
string | null
Display name.
phone
string | null
Phone.
is_active
boolean
Whether the account is active.
email_verified
boolean
Email verification state.
totp_enabled
boolean
Whether TOTP is enabled.
metadata
object
Custom metadata.
last_login_method
string | null
Last authentication method.
roles
string[]
Role slugs.
permissions
string[]
Permission slugs.
Each successful call hits the database.

Status codes

CodeMeaning
200Success
401Missing, invalid, or revoked token
403IP or firewall block, or email verification required
429Rate limited