OAuth2 Authorization Endpoint

GET

/oauth2/authorize

• Nhost Authentication API Server

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

Parameters

Query Parameters

client_id

required

string

The OAuth2 client identifier (RFC 6749 Section 2.2).

redirect_uri

required

string

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

response_type

required

string

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

scope

string

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

state

string

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

nonce

string

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

code_challenge

string

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

code_challenge_method

string

Allowed values: S256

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

resource

string

Resource indicator for the target service (RFC 8707).

prompt

string

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

Responses

302

Redirect to login UI or back to client with error

Headers

Location

string format: uri

default

OAuth2 error response

object

error

required

OAuth2 error code

string

error_description

Human-readable error description

string