Authorize

Starts the OAuth2 authorization code flow. This endpoint redirects the user to login and consent (if needed), then redirects back to your redirect_uri with a code and state.

Query parameters

client_idstringRequired

The OAuth application client ID (uid).

redirect_uristringRequired
Must exactly match one of the app's configured redirect URIs.
response_typestringRequired

Must be code for the authorization code flow.

scopestringOptional

Space-delimited list of requested scopes.

statestringOptional
Opaque value returned to your callback for CSRF protection.
code_challengestringOptional
PKCE code challenge for public clients.
code_challenge_methodenumOptional

PKCE challenge method (plain or S256).

Allowed values:

Response

Redirect

Errors