Skip to Content
🎉 New release with new features and improvements! V0.0.4 Release →
DocumentationsBsh EngineAPI ReferenceAuthentication

Authentication API

The Authentication API provides endpoints for user authentication, token management, and password operations.

Base Endpoint

/api/auth

The system will automatically set authentication cookies with the generated tokens upon login or refresh. You usually don’t need to handle the tokens manually unless your use-case is purely token-based.

BSH Engine Collection

Endpoints

MethodEndpointDescription
POST/api/auth/registerRegister new user
POST/api/auth/activate-accountActivate user account using verification code
POST/api/auth/loginAuthenticate user with email and password
POST/api/auth/refreshRefresh expired access token
POST/api/auth/forget-passwordRequest password reset code via email
POST/api/auth/reset-passwordReset password using verification code
POST/api/auth/resend-activation-emailResend activation email to the user

Token Usage

The Engine API supports two methods of authentication. You can use either one depending on your use case.

Include the access token in the Authorization header:

Authorization: Bearer {{accessToken}}

Authentication Flow

AuthenticationPOST Register