Skip to content

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.

MethodEndpointDescriptionAuth
POST/auth/signupCreate new user accountTenant
POST/auth/signinUser sign-in with various methodsTenant
POST/auth/refresh-tokenRefresh access tokenTenant
GET/auth/logoutSign out current sessionTenant + User
POST/auth/terminateDelete account (soft/hard delete)Tenant + User
POST/auth/reset-passwordReset 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 ​

MethodDescriptionSupported Capabilities
passwordEmail and passwordsignin, signup, reset-password
otpOne-time password (email/SMS)signin

Social ​

MethodDescriptionSupported Capabilities
facebookFacebook OAuth tokensignin
googleGoogle OAuth tokensignin
appleApple Sign In tokensignin

Other ​

MethodDescriptionSupported Capabilities
guestGuest user (temporary)signin

Documentation ​