v1

latestOpenAPI 3.0.3Apache 2.02026-07-175068227.4 KB

oAuth2

Reject OAuth 2.0 Login Request

When an authorization code, hybrid, or implicit OAuth 2.0 Flow is initiated, Ory asks the login provider to authenticate the subject and then tell the Ory OAuth2 Service about it.

The authentication challenge is appended to the login provider URL to which the subject's user-agent (browser) is redirected to. The login provider uses that challenge to fetch information on the OAuth2 request and then accept or reject the requested authentication process.

This endpoint tells Ory that the subject has not authenticated and includes a reason why the authentication was denied.

The response contains a redirect URL which the login provider should redirect the user-agent to.

put/admin/oauth2/auth/requests/login/reject

Query parameters

login_challengestring required

OAuth 2.0 Login Request Challenge

Request body

errorstring

The error should follow the OAuth2 error format (e.g. invalid_request, login_required).

Defaults to request_denied.

error_debugstring

Debug contains information to help resolve the problem as a developer. Usually not exposed to the public but only in the server logs.

error_descriptionstring

Description of the error in a human readable format.

error_hintstring

Hint to help resolve the error.

status_codeinteger

Represents the HTTP status code of the error (e.g. 401 or 403)

Defaults to 400

Response

oAuth2RedirectTo

redirect_tostring required

RedirectURL is the URL which you should redirect the user's browser to once the authentication process is completed.

Example response

{
  "redirect_to": "redirect_to"
}