Skip to content

Latest commit

 

History

History
103 lines (84 loc) · 3.86 KB

File metadata and controls

103 lines (84 loc) · 3.86 KB

API Endpoint Catalogue

Base prefix: /api/v1

API Keys

Method Endpoint Purpose
GET /api/v1/api-keys List Api Keys
POST /api/v1/api-keys Create Api Key
DELETE /api/v1/api-keys/{api_key_id} Revoke Api Key
POST /api/v1/api-keys/{api_key_id}/rotate Rotate Api Key

Administration

Method Endpoint Purpose
GET /api/v1/admin/users List Users
DELETE /api/v1/admin/users/{user_id} Delete User
GET /api/v1/admin/users/{user_id} Get User
PATCH /api/v1/admin/users/{user_id}/status Update User Status
POST /api/v1/admin/users/{user_id}/unlock Unlock User

Audit Logs

Method Endpoint Purpose
GET /api/v1/audit-logs List Audit Logs

Authentication

Method Endpoint Purpose
POST /api/v1/auth/email/change/confirm Confirm Email Change
POST /api/v1/auth/email/change/request Request Email Change
POST /api/v1/auth/login Login
POST /api/v1/auth/logout Logout
POST /api/v1/auth/logout-all Logout All
GET /api/v1/auth/me Me
PATCH /api/v1/auth/me Update Me
POST /api/v1/auth/mfa/verify-login Verify Login Mfa
POST /api/v1/auth/password/change Change Password
POST /api/v1/auth/password/forgot Forgot Password
POST /api/v1/auth/password/reset Reset Password
POST /api/v1/auth/refresh Refresh
POST /api/v1/auth/register Register
POST /api/v1/auth/resend-verification Resend Verification
POST /api/v1/auth/token OAuth2-compatible password token endpoint
POST /api/v1/auth/verify-email Verify Email

Multi-Factor Authentication

Method Endpoint Purpose
POST /api/v1/mfa/backup-codes/regenerate Regenerate Backup Codes
POST /api/v1/mfa/totp/confirm Confirm Totp
POST /api/v1/mfa/totp/disable Disable Totp
POST /api/v1/mfa/totp/setup Setup Totp

Organizations

Method Endpoint Purpose
POST /api/v1/invitations/accept Accept Invitation
GET /api/v1/organizations List Organizations
POST /api/v1/organizations Create Organization
DELETE /api/v1/organizations/{organization_id} Suspend Organization
GET /api/v1/organizations/{organization_id} Get Organization
PATCH /api/v1/organizations/{organization_id} Update Organization
GET /api/v1/organizations/{organization_id}/invitations List Invitations
POST /api/v1/organizations/{organization_id}/invitations Create Invitation
GET /api/v1/organizations/{organization_id}/members List Members
DELETE /api/v1/organizations/{organization_id}/members/{member_user_id} Remove Member
PATCH /api/v1/organizations/{organization_id}/members/{member_user_id} Update Member

RBAC

Method Endpoint Purpose
GET /api/v1/rbac/permissions List Permissions
GET /api/v1/rbac/roles List Roles
POST /api/v1/rbac/roles Create Role
DELETE /api/v1/rbac/roles/{role_id} Delete Role
GET /api/v1/rbac/roles/{role_id} Get Role
PATCH /api/v1/rbac/roles/{role_id} Update Role
DELETE /api/v1/rbac/users/{user_id}/roles/{role_id} Remove User Role
POST /api/v1/rbac/users/{user_id}/roles/{role_id} Assign User Role

Sessions

Method Endpoint Purpose
DELETE /api/v1/sessions Revoke Other Sessions
GET /api/v1/sessions List Sessions
DELETE /api/v1/sessions/{session_id} Revoke Session

System

Method Endpoint Purpose
GET / Root
GET /health/live Live
GET /health/ready Ready