OpenId4VpRequestOptions

data class OpenId4VpRequestOptions(val credentials: Set<RequestOptionsCredential>, val presentationMechanism: PresentationMechanismEnum = PresentationMechanismEnum.PresentationExchange, val responseMode: OpenIdConstants.ResponseMode = OpenIdConstants.ResponseMode.Fragment, val responseUrl: String? = null, val responseType: String = VP_TOKEN, val state: String = uuid4().toString(), val encryption: Boolean = false, val transactionData: List<TransactionData>? = null, val expectedOrigins: List<String>? = null, val populateClientId: Boolean = true) : RequestOptions(source)

Constructors

Link copied to clipboard
constructor(credentials: Set<RequestOptionsCredential>, presentationMechanism: PresentationMechanismEnum = PresentationMechanismEnum.PresentationExchange, responseMode: OpenIdConstants.ResponseMode = OpenIdConstants.ResponseMode.Fragment, responseUrl: String? = null, responseType: String = VP_TOKEN, state: String = uuid4().toString(), encryption: Boolean = false, transactionData: List<TransactionData>? = null, expectedOrigins: List<String>? = null, populateClientId: Boolean = true)

Properties

Link copied to clipboard

Requested credentials, should be at least one.

Link copied to clipboard
Link copied to clipboard

REQUIRED when signed requests defined in Appendix A.3.2 are used with the Digital Credentials API(DC API). A non-empty array of strings, each string representing an Origin of the Verifier that is making the request. The Wallet MUST compare values in this parameter to the Origin to detect replay of the request from a malicious Verifier. If the Origin does not match any of the entries in expected_origins, the Wallet MUST return an error. This error SHOULD be an invalid_request error. This parameter is not for use in unsigned requests and therefore a Wallet MUST ignore this parameter if it is present in an unsigned request.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

Whether the client_id should be added to the request. Required for DC API: The client_id parameter MUST be omitted in unsigned requests defined in Appendix A.3.1. The client_id parameter MUST be present in signed requests defined in Appendix A.3.2, as it communicates to the Wallet which Client Identifier Prefix and Client Identifier to use when authenticating the client through verification of the request signature or retrieving client metadata.

Link copied to clipboard

Presentation mechanism to be used for requesting credentials.

Link copied to clipboard

Response mode to request, see OpenIdConstants.ResponseMode, by default OpenIdConstants.ResponseMode.Fragment. Setting this to any other value may require setting responseUrl too.

Link copied to clipboard

Response type to set in at.asitplus.openid.AuthenticationRequestParameters.responseType, by default only vp_token (as per OpenID4VP spec, see OpenIdConstants.VP_TOKEN). Be sure to separate values by a space, e.g. vp_token id_token (see OpenIdConstants.ID_TOKEN).

Link copied to clipboard
open override val state: String

Opaque value which will be returned by the OpenId Provider and also in AuthnResponseResult.

Link copied to clipboard

Non-empty array of strings, where each string is a base64url-encoded JSON object that contains a typed parameter set with details about the transaction that the Verifier is requesting the End-User to authorize.

Functions

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard