The Authentication API handles client registration, login, token management, multi-factor authentication (MFA), and team account management. All endpoints use the /api/v1/auth base path.
| Method | Endpoint | Description |
|---|
POST | /api/v1/auth/register | Register a new client account |
POST | /api/v1/auth/register/verify-email | Verify client email address during registration |
POST | /api/v1/auth/register/resend-verification | Resend the email verification code |
POST | /api/v1/auth/login | Log in with client credentials |
POST | /api/v1/auth/login/verify-otp | Verify OTP code during login |
POST | /api/v1/auth/login/challenge/send-email-code | Send an email code for login challenge verification |
POST | /api/v1/auth/logout | Log out and invalidate the current session |
| Method | Endpoint | Description |
|---|
POST | /api/v1/auth/api-token | Obtain an API token for server-to-server authentication |
POST | /api/v1/auth/refresh | Refresh an expired access token using a refresh token |
POST | /api/v1/auth/refresh-api-key | Regenerate the API key for the client |
POST | /api/v1/auth/security/request-code | Request a security verification code for sensitive operations |
| Method | Endpoint | Description |
|---|
GET | /api/v1/auth/client/me | Retrieve the current client's profile information |
PUT | /api/v1/auth/client/settings | Update client account settings |
| Method | Endpoint | Description |
|---|
GET | /api/v1/auth/mfa/client-defaults | Get the default MFA configuration for the client |
PUT | /api/v1/auth/mfa/client-defaults | Update the default MFA configuration |
GET | /api/v1/auth/mfa/me | Get MFA settings for the current user |
PUT | /api/v1/auth/mfa/me | Update MFA settings for the current user |
POST | /api/v1/auth/mfa/totp/enroll/start | Start TOTP authenticator enrollment and receive a QR code |
POST | /api/v1/auth/mfa/totp/enroll/confirm | Confirm TOTP enrollment with a verification code |
POST | /api/v1/auth/mfa/totp/disable | Disable TOTP authenticator for the current user |
| Method | Endpoint | Description |
|---|
GET | /api/v1/auth/team/accounts | List all team member accounts |
POST | /api/v1/auth/team/accounts | Create a new team member account |
GET | /api/v1/auth/team/accounts/me | Get the current user's team account details |
PATCH | /api/v1/auth/team/accounts/{account_id} | Update a team member's account |
DELETE | /api/v1/auth/team/accounts/{account_id} | Delete a team member account |
POST | /api/v1/auth/team/accounts/me/change-password | Change the current user's password |
