Are you an LLM? Read llms.txt for a summary of the docs, or llms-full.txt for the full context.
Skip to content

API Reference

Relying Party (RP) Endpoints

EndpointDescription
GET /rp/authorizeInitiate OAuth flow with external IdP
GET /rp/callback/:idpOAuth callback handler
GET /rp/userinfoGet current user info (requires auth)
POST /signoutSign out and clear session

OIDC Provider (OP) Endpoints

EndpointDescription
GET /.well-known/openid-configurationOIDC discovery document
GET /oauth2/jwks.jsonJSON Web Key Set
GET /oauth2/authorizeAuthorization endpoint
POST /oauth2/tokenToken endpoint
GET /oauth2/userinfoUserInfo endpoint
POST /oauth2/revokeToken revocation endpoint

User APIs

EndpointDescription
GET /api/users/meGet current user profile
GET /api/users/me/identitiesGet linked identity providers
GET /api/sessionsList current user's sessions
DELETE /api/sessions/:idRevoke specific session
DELETE /api/sessionsRevoke all other sessions

Management APIs (Admin Required)

Identity Providers

EndpointDescription
GET /api/idpsList identity providers
POST /api/idpsCreate identity provider
GET /api/idps/:idGet IdP details
PUT /api/idps/:idUpdate identity provider
DELETE /api/idps/:idDelete identity provider

OAuth Clients

EndpointDescription
GET /api/clientsList OAuth clients
POST /api/clientsCreate OAuth client
GET /api/clients/:idGet client details
PUT /api/clients/:idUpdate client
DELETE /api/clients/:idDelete client
POST /api/clients/:id/rotate-secretRotate client secret

Users

EndpointDescription
GET /api/usersList all users (paginated)
GET /api/users/:idGet user by ID
PUT /api/users/:idUpdate user profile
DELETE /api/users/:idDelete user
GET /api/users/:id/sessionsList user's active sessions
DELETE /api/users/:id/sessionsRevoke all user sessions
DELETE /api/users/:id/identities/:linkIdUnlink identity provider

Roles & Permissions

EndpointDescription
GET /api/rolesList roles and permissions
GET /api/roles/:idGet role with permissions
POST /api/rolesCreate custom role
PUT /api/roles/:idUpdate role
DELETE /api/roles/:idDelete role
POST /api/users/:id/rolesAssign role to user
DELETE /api/users/:id/roles/:roleIdRemove role from user
GET /api/permissionsList all permissions
POST /api/roles/:id/permissionsAdd permission to role
DELETE /api/roles/:id/permissions/:permIdRemove permission from role

Audit Log

EndpointDescription
GET /api/auditList audit events (paginated)
GET /api/audit/:idGet audit event details
GET /api/audit/eventsList event types with counts
GET /api/users/:id/auditUser's audit history

Health Check

EndpointDescription
GET /healthFull health check (database + JWKS)
GET /health/liveSimple liveness probe