Initiate the OAuth Authorization Code flow.

get

{protocol}://{base-url}/oauth/v1/authorize

Initiates the OAuth 2.0 Authorization Code flow. Authenticates the user and redirects to the provided redirect URI with an authorization code.

Notes:

* PKCE is required for public clients and optional for confidential clients based on their configuration.

Query Params

response_type

string

enum

required

Type of authorization response expected from the authorization server.

Allowed:

response_mode

string

enum

Defaults to query

Indicates how the authorization server returns the response parameters to the client.

Allowed:

redirect_uri

uri

required

Registered redirect URI that receives the authorization code.

client_id

string

required

OAuth client identifier.

code_challenge_method

string

enum

PKCE code-challenge method. Required for public clients (S256 only).

Allowed:

code_challenge

string

Base64url-encoded SHA-256 of the code_verifier. Required for public clients.

state

string

Optional value to maintain state between request and callback.

scope

string

Optional space-delimited list of requested scopes.

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

Language

URL

Loading…

Response

Choose an example:

text/html

application/json

200Authorization page rendered successfully.

302Redirects to the client’s redirect URI with code and optional state.

400Malformed request.