Sign in
oauth

Generate OAuth authorization URL

Generate OAuth authorization URL with state and nonce for CSRF and replay attack protection. State is stored with TTL for validation.

get/api/oauth/auth-url

Query parameters

redirect_uristring required

The URI to redirect to after OAuth consent. Must match the registered redirect URI in OAuth client configuration.

The URI to redirect to after OAuth consent. Must match the registered redirect URI in OAuth client configuration.

code_challengestring nullable

PKCE code challenge derived from code_verifier. Required for public clients to prevent authorization code interception attacks.

PKCE code challenge derived from code_verifier. Required for public clients to prevent authorization code interception attacks.

code_challenge_methodstring nullable

PKCE code challenge method, typically 'S256' (SHA-256 hash). Must be provided if code_challenge is specified.

PKCE code challenge method, typically 'S256' (SHA-256 hash). Must be provided if code_challenge is specified.

Response

Successful Response

urlstring uri required

OAuth provider authorization URL to redirect the user to for consent

Changes

Changed in 3 of the 79 revisions of this API.13

  • 815e0302a98811See the full diff
    • ▲

      response property detail list-of-types was widened by adding types string to media type application/json of response 422

      response-property-list-of-types-widened

    • ○

      the response property became required for the status

      response-property-became-required

  • c3e15c78f2da1See the full diff
    • ○

      added the non-success response with the status

      response-non-success-status-added

  • 6397cb5a99c51See the full diff
    • ○

      api operation id get_auth_url_api_oauth_auth_url_get removed and replaced with get_auth_url

      api-operation-id-removed

    This revision also has 5 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog