Skip to main content
GET
/
api
/
oauth
/
auth-url
Generate OAuth Authorization URL
curl --request GET \
  --url https://api.example.com/api/oauth/auth-url
{
  "url": "<string>"
}

Query Parameters

redirect_uri
string
required

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

code_challenge
string | null

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

code_challenge_method
string | null

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

Response

Successful Response

Response containing OAuth authorization URL

url
string<uri>
required
Required string length: 1 - 2083