v1
latestOpenAPI 3.0.32026-07-2613529376.3 KBAuthentication
OAuth 2.0 Authorization
The endpoint initiates the OAuth 2.0 authorization flow for user authentication and obtaining an authorization code.
Using the State Parameter (Best Practice)
The state parameter is crucial for security in OAuth flows:
- Generate a cryptographically secure random string
- Store it in the session before redirecting
- Validate it matches when handling the callback
- This prevents CSRF attacks <Note>
Note: OAuth scopes are predefined during client application setup and cannot be modified during the authorization request. The access token will include all scopes that were approved during client creation. </Note>
get/auth/login
Query parameters
clientIdstring required
Example:YOUR_CLIENT_ID
The application's client ID
statestring
Example:SECURE_RANDOM_STATE
A secure random string used to maintain state between the request and callback and prevent CSRF attacks (Recommended)