For the complete documentation index, see llms.txt. This page is also available as Markdown.

Finish the OAuth2 authorization flow after user consent

Called by the consent screen once the user allows or denies the request. On approval it redirects back to the client with an authorization code.

post
Authorizations
defguard_sessionstringRequired
Query parameters
client_idstringRequired

ID of the OAuth2 client.

redirect_uristringRequired

Redirect URI registered for the client.

response_typestringRequired

OAuth2 response type, for example code.

scopestringRequired

Space-separated list of requested scopes.

statestringRequired

Opaque value returned unchanged to the client.

noncestringOptional

Value bound to the ID token to mitigate replay attacks.

code_challengestringOptional

PKCE code challenge.

code_challenge_methodstringOptional

PKCE code challenge method, for example S256.

promptstringOptional

OpenID prompt parameter, for example consent.

allowbooleanOptional

Set by the consent screen to allow or deny the request.

Responses
302

Redirect to the client redirect URI with an authorization code or an error.

No content

post/api/v1/oauth/authorize
POST /api/v1/oauth/authorize?client_id=text&redirect_uri=text&response_type=text&scope=text&state=text HTTP/1.1
Accept: */*

No content

Last updated

Was this helpful?