vck-openid/at.asitplus.wallet.lib.oidc/OidcSiopVerifier/RequestOptions

RequestOptions

data class RequestOptions(val credentials: Set<OidcSiopVerifier.RequestOptionsCredential>, val responseMode: OpenIdConstants.ResponseMode = OpenIdConstants.ResponseMode.Fragment, val responseUrl: String? = null, val responseType: String = VP_TOKEN, val state: String = uuid4().toString(), val clientMetadataUrl: String? = null, val encryption: Boolean = false)(source)

Constructors

RequestOptions

constructor(credentials: Set<OidcSiopVerifier.RequestOptionsCredential>, responseMode: OpenIdConstants.ResponseMode = OpenIdConstants.ResponseMode.Fragment, responseUrl: String? = null, responseType: String = VP_TOKEN, state: String = uuid4().toString(), clientMetadataUrl: String? = null, encryption: Boolean = false)

Properties

clientMetadataUrl

val clientMetadataUrl: String? = null

Optional URL to include metadata by reference instead of by value (directly embedding in authn request)

credentials

val credentials: Set<OidcSiopVerifier.RequestOptionsCredential>

Requested credentials, should be at least one

encryption

val encryption: Boolean = false

Set this value to include metadata with encryption parameters set. Beware if setting this value and also clientMetadataUrl, that the URL shall point to OidcSiopVerifier.metadataWithEncryption.

responseMode

val responseMode: OpenIdConstants.ResponseMode

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

responseType

val responseType: String

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

responseUrl

val responseUrl: String? = null

Response URL to set in the AuthenticationRequestParameters.responseUrl, required if responseMode is set to OpenIdConstants.ResponseMode.DirectPost or OpenIdConstants.ResponseMode.DirectPostJwt.

state

val state: String

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