v15

latestOpenAPI 3.0.0MIT Licenseraw.githubusercontent.com2026-08-016088119.5 KB
authentication

OAuth2 Authorization Endpoint

Initiates an OAuth2 authorization code flow. Validates the request and redirects to the login UI for user authentication and consent.

get/oauth2/authorize

Query parameters

client_idstring required

The OAuth2 client identifier (RFC 6749 Section 2.2).

redirect_uristring required

The URI to redirect the user-agent to after authorization (RFC 6749 Section 3.1.2).

response_typestring required

The authorization response type. Only 'code' is supported (RFC 6749 Section 3.1.1).

scopestring

Space-delimited list of requested scopes (RFC 6749 Section 3.3).

statestring

Opaque value used to maintain state between the request and callback (RFC 6749 Section 4.1.1).

noncestring

String value used to associate a client session with an ID token (OpenID Connect Core Section 3.1.2.1).

code_challengestring

PKCE code challenge derived from the code verifier (RFC 7636 Section 4.2).

code_challenge_method'S256'

Only S256 is supported. The plain method is not allowed.

resourcestring

Resource indicator for the target service (RFC 8707).

promptstring

Space-delimited list of prompts to present to the user (OpenID Connect Core Section 3.1.2.1).

Response

OAuth2 error response

errorstring required

OAuth2 error code

error_descriptionstring

Human-readable error description