v1

latestOpenAPI 3.0.1License2026-07-17467229.7 KB
Authorization

The Authorization Endpoint performs Authentication of the End-User.

End-User Authentication and Authorization done by sending the User Agent to the Authorization Endpoint using request parameters defined by OAuth 2.0 and OpenID Connect.

get/restv1/authorize

Query parameters

scopestring required

OpenID Connect requests MUST contain the openid scope value. If the openid scope value is not present, the behavior is entirely unspecified. Other scope values MAY be present.

response_typestring required

OAuth 2.0 Response Type value that determines the authorization processing flow to be used, including what parameters are returned from the endpoints used.

client_idstring required

OAuth 2.0 Client Identifier valid at the Authorization Server.

redirect_uristring required

Redirection URI to which the response will be sent. This URI MUST exactly match one of the Redirection URI values for the Client pre-registered at the OpenID Provider.

statestring

Opaque value used to maintain state between the request and the callback.

response_modestring

Informs the Authorization Server of the mechanism to be used for returning parameters from the Authorization Endpoint.

noncestring

String value used to associate a Client session with an ID Token, and to mitigate replay attacks.

displaystring

ASCII string value that specifies how the Authorization Server displays the authentication and consent user interface pages to the End-User.

promptstring

Space delimited, case sensitive list of ASCII string values that specifies whether the Authorization Server prompts the End-User for reauthentication and consent. The defined values are - none, login, consent, select_account.

max_ageinteger

Maximum Authentication Age. Specifies the allowable elapsed time in seconds since the last time the End-User was actively authenticated by the OP.

ui_localesstring

End-User's preferred languages and scripts for the user interface, represented as a space-separated list of BCP47 [RFC5646] language tag values, ordered by preference.

id_token_hintstring

ID Token previously issued by the Authorization Server being passed as a hint about the End-User's current or past authenticated session with the Client. If the End-User identified by the ID Token is logged in or is logged in by the request, then the Authorization Server returns a positive response.

login_hintstring

Hint to the Authorization Server about the login identifier the End-User might use to log in (if necessary).

acr_valuesstring

Requested Authentication Context Class Reference values. Space-separated string that specifies the acr values that the Authorization Server is being requested to use for processing this Authentication Request, with the values appearing in order of preference.

amr_valuesstring

AMR Values.

requeststring

This parameter enables OpenID Connect requests to be passed in a single, self-contained parameter and to be optionally signed and/or encrypted. The parameter value is a Request Object value. It represents the request as a JWT whose Claims are the request parameters.

request_uristring

This parameter enables OpenID Connect requests to be passed by reference, rather than by value. The request_uri value is a URL using the https scheme referencing a resource containing a Request Object value, which is a JWT containing the request parameters.

request_session_idstring

Request session id.

session_idstring

Session id of this call.

origin_headersstring

Origin headers. Used in custom workflows.

code_challengestring

PKCE code challenge.

code_challenge_methodstring

PKCE code challenge method.

custom_response_headersstring

Custom Response Headers.

claimsstring

Requested Claims.

auth_req_idstring

CIBA authentication request Id.

dpop_jktstring

The JSON Web Key (JWK) Thumbprint [RFC7638] of the proof-of-possession public key using the SHA-256 hash function

logout_status_jwtstring

Possible values are true or false. Returns back Logout Status JWT if send logout_status_jwt=true and authorization is successful.

authorization_detailsstring

The request parameter authorization_details contains, in JSON notation, an array of objects. Each JSON object contains the data to specify the authorization requirements for a certain type of resource. The type of resource or access requirement is determined by the type field.

Response

OK