Appearance
Overview
The Auth module manages user authentication and authorization with support for multiple authentication methods.
Endpoints
Each endpoint represents a specific capability in the Auth module.
| Method | Endpoint | Description | Auth |
|---|---|---|---|
POST | /auth/signup | Create new user account | Tenant |
POST | /auth/signin | User sign-in with various methods | Tenant |
POST | /auth/refresh-token | Refresh access token | Tenant |
GET | /auth/logout | Sign out current session | Tenant + User |
POST | /auth/terminate | Delete account (soft/hard delete) | Tenant + User |
POST | /auth/reset-password | Reset user password (2-step) | Tenant |
Authentication Methods
The Auth module supports multiple authentication methods. Each method can be used with specific capabilities (operations). Methods are grouped by type below.
Traditional
| Method | Description | Supported Capabilities |
|---|---|---|
password | Email and password | signin, signup, reset-password |
otp | One-time password (email/SMS) | signin |
Social
| Method | Description | Supported Capabilities |
|---|---|---|
facebook | Facebook OAuth token | signin |
google | Google OAuth token | signin |
apple | Apple Sign In token | signin |
Other
| Method | Description | Supported Capabilities |
|---|---|---|
guest | Guest user (temporary) | signin |