IBibm
Authorize Endpoint

Use this endpoint to trigger authorization request

The authorization endpoint is used to interact with the resource owner and obtain an authorization grant. The authorization server MUST first verify the identity of the resource owner.

post/authorize

Request

  • Base URL
    https://{pointofcontact}/oauth2
  • Auth
    none declared

Request body application/x-www-form-urlencoded

requeststring

Request object, signed and/or encrypted JWT. When used, it may contain all the properties below. For FAPI, besides parameters used by client authentication, all the other parameters should be inside the request object. Based on OIDC specification, it is possible to have the same parameters inside and outside request object, but the one inside the request object will supercede the one outside.

request_uristring

A URI pointing to request object. Upon receiving this, the OIDC Provider is expected to fetch the request object first. In the case of Pushed Authorize scenario, the request_uri points to a location known by OIDC Provider.

client_idstring

OAuth 2.0 Client identifier

response_type'code' | 'token' | 'id_token' | 'code token' | 'code id_token' | 'token id_token' | 'code token id_token' | 'none'

OAuth 2.0 response_type value that determines the authorization processing flow to be used

response_mode'query' | 'fragment' | 'form_post'

Mechanism to be used for returning parameters from the Authorization Endpoint

redirect_uristring

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 OIDC Provider

acr_valuesstring

A space-separated string that specifies the requested Authentication Context Class Reference values, with the values appearing in order of preference.

statestring

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

noncestring

Value used to associate a Client session with an ID Token to mitigate replay attacks

prompt'none' | 'login' | 'consent' | 'login consent'

Space-delimited string that specifies whether the Authorization Server prompts the End-User for reauthentication and consent.

max_agenumber

Maximum Authentication Age. Specifies the allowable elapsed time in seconds since the last time the End-User was actively authenticated by the OIDC Provider. If the elapsed time is greater than this value, the OIDC Provider MUST attempt to actively re-authenticate the End-User.

code_challengestring

Code challenge used as proof for code exchange

code_challenge_method'S256'

Method used to calculate the code challenge

scopestring

Space-delimited string indicating the OAuth 2.0 scope requested. OpenID Connect requests MUST contain the openid scope value.

claimsstring

JSON string that contains individual claims requested.

login_hintstring

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

Response

Authorization page response

Changes

No recorded changes to this operation across all 1 revision of this API.