OAuth Authorization

Initiates the OAuth 2.0 Authorization Code flow by redirecting the user to the authorization server. Upon successful authorization, the server redirects the user to the specified redirectUri with an authorization code that can be exchanged for an access token.

Query Parameters

Parameter	Required	Description
`responseType`	✅ Yes	Specifies the OAuth 2.0 response type. Must be set to `code` to initiate the Authorization Code flow.
`clientId`	✅ Yes	The unique identifier of the registered client application (e.g., `client-id-123`).
`redirectUri`	✅ Yes	The URI to which the authorization server will redirect the user after granting or denying access (e.g., `https://example.com/callback`). Must match the URI registered with the authorization server.
`scope`	✅ Yes	A space-separated or comma-separated list of permissions being requested (e.g., `read write` or `read,write`). Defines the level of access the application is requesting.
`state`	✅ Yes	An opaque value used to maintain state between the request and the callback (e.g., `state-123`). Helps prevent CSRF attacks by verifying the response matches the request.

Responses

200 OK — Authorization code generated successfully The user has been successfully authorized. The response includes an authorization code that the client can exchange for an access token.

400 Bad Request — Invalid input parameters The request was malformed or contained invalid/missing parameters. Check that all required query parameters are present and correctly formatted.

Query parameters

responseTypestringOptional

OAuth response type (typically “code”)

clientIdstringOptional

OAuth client ID

redirectUristringOptional

Redirect URI for OAuth callback

scopestringOptional

OAuth scope

statestringOptional

State parameter for OAuth flow