post
Exchange email/password for a session token
- Operation ID
- login
- Authentication
- No authentication
- Request body
- Present · required
Parameters: none declared.
Response codes
200 · 400 · 401 · 403 · 404 · 409 · 429
Stable API tag
auth
Authentication, sessions, and setup
5 paths · 5 operations
/v1/auth/login
/v1/auth/logout
post
Revoke the calling session
- Operation ID
- logout
- Authentication
- Bearer token
- Request body
- None
Parameters: none declared.
Response codes
204 · 400 · 401 · 403 · 404 · 409 · 429
/v1/auth/refresh
post
Renew the calling session token (rotates the credential, extends expiry)
- Operation ID
- refreshToken
- Authentication
- Bearer token
- Request body
- None
Parameters: none declared.
Response codes
200 · 400 · 401 · 403 · 404 · 409 · 429
/v1/auth/whoami
get
The calling principal and its tenant grants
- Operation ID
- whoami
- Authentication
- Bearer token
- Request body
- None
Parameters: none declared.
Response codes
200 · 400 · 401 · 403 · 404 · 409 · 429
/v1/setup
post
Create the first superadmin with the one-time setup token
- Operation ID
- setupFirstAdmin
- Authentication
- No authentication
- Request body
- Present · required
Parameters: none declared.
Response codes
201 · 400 · 401 · 403 · 404 · 409 · 429