v1

latestOpenAPI 3.0.0Apache-2.02026-07-17326898.9 KB
oidc4ci

OIDC Authorization Request

OAuth 2.0 Authorization Request, which requests to grant access to the Credential endpoint.

get/oidc/authorize

Query parameters

response_typestring required

Value MUST be set to "code".

client_idstring required

The client identifier.

code_challengestring required

A challenge derived from the code verifier that is sent in the authorization request, to be verified against later.

code_challenge_methodstring

A method that was used to derive code challenge.

redirect_uristring

The authorization server redirects the user-agent to the client's redirection endpoint previously established with the authorization server during the client registration process or when making the authorization request.

scopestring

The scope of the access request.

statestring

An opaque value used by the client to maintain state between the request and callback. The authorization server includes this value when redirecting the user-agent back to the client. The parameter SHOULD be used for preventing cross-site request forgery.

authorization_detailsstring

Encoded array of the authorization_details conveys the details about the credentials the wallet wants to obtain. Multiple authorization_details can be used with type openid_credential to request authorization in case of multiple credentials.

wallet_issuerstring

Wallet's OpenID Connect Issuer URL. The Issuer will use the discovery process to determine the wallet's capabilities and endpoints. RECOMMENDED in Dynamic Credential Request.

user_hintstring

An opaque user hint the wallet MAY use in subsequent callbacks to optimize the user's experience. RECOMMENDED in Dynamic Credential Request.

issuer_statestring

String value identifying a certain processing context at the credential issuer. A value for this parameter is typically passed in an issuance initiation request from the issuer to the wallet. This request parameter is used to pass the issuer_state value back to the credential issuer. The issuer must take into account that op_state is not guaranteed to originate from this issuer, could be an attack.

client_id_schemestring

String indicating that client is using an identifier not assigned by the authorization server. The only supported value "urn:ietf:params:oauth:client-id-scheme:oauth-discoverable-client" specifies "client_id" parameter in the request as an HTTPS based URL corresponding to the "client_uri". If the authorization server does not already have the metadata for the identified client, it can retrieve the metadata from client’s well-known location.