openid-data-classes/at.asitplus.openid/AuthorizationDetails/OpenIdCredential

OpenIdCredential

@Serializable

@SerialName(value = "openid_credential")

data class OpenIdCredential(val credentialConfigurationId: String? = null, val format: CredentialFormatEnum? = null, val docType: String? = null, val claims: Map<String, Map<String, RequestedCredentialClaimSpecification>>? = null, val credentialDefinition: SupportedCredentialFormatDefinition? = null, val sdJwtVcType: String? = null, val locations: Set<String>? = null, val credentialIdentifiers: Set<String>? = null) : AuthorizationDetails(source)

OID4VCI: The request parameter authorization_details defined in Section 2 of (RFC9396) MUST be used to convey the details about the Credentials the Wallet wants to obtain. This specification introduces a new authorization details type openid_credential and defines the following parameters to be used with this authorization details type.

Constructors

OpenIdCredential

constructor(credentialConfigurationId: String? = null, format: CredentialFormatEnum? = null, docType: String? = null, claims: Map<String, Map<String, RequestedCredentialClaimSpecification>>? = null, credentialDefinition: SupportedCredentialFormatDefinition? = null, sdJwtVcType: String? = null, locations: Set<String>? = null, credentialIdentifiers: Set<String>? = null)

Properties

claims

@SerialName(value = "claims")

val claims: Map<String, Map<String, RequestedCredentialClaimSpecification>>? = null

OID4VCI: ISO mDL: OPTIONAL. Object as defined in Appendix A.3.2 excluding the display and value_type parameters. The mandatory parameter here is used by the Wallet to indicate to the Issuer that it only accepts Credential(s) issued with those claim(s).

credentialConfigurationId

@SerialName(value = "credential_configuration_id")

val credentialConfigurationId: String? = null

OID4VCI: REQUIRED when format parameter is not present. String specifying a unique identifier of the Credential being described in IssuerMetadata.supportedCredentialConfigurations.

credentialDefinition

@SerialName(value = "credential_definition")

val credentialDefinition: SupportedCredentialFormatDefinition? = null

OID4VCI: W3C VC: OPTIONAL. Object containing a detailed description of the Credential consisting of the following parameters, see SupportedCredentialFormatDefinition.

credentialIdentifiers

@SerialName(value = "credential_identifiers")

val credentialIdentifiers: Set<String>? = null

OID4VCI: REQUIRED. Array of strings, each uniquely identifying a Credential Dataset that can be issued using the Access Token returned in this response. Each of these Credential Datasets corresponds to the same Credential Configuration in the IssuerMetadata.supportedCredentialConfigurations. The Wallet MUST use these identifiers together with an Access Token in subsequent Credential Requests.

docType

@SerialName(value = "doctype")

val docType: String? = null

OID4VCI: ISO mDL: OPTIONAL. This claim contains the type value the Wallet requests authorization for at the Credential Issuer. It MUST only be present if the format claim is present. It MUST not be present otherwise.

format

@SerialName(value = "format")

val format: CredentialFormatEnum? = null

OID4VCI: REQUIRED when credentialConfigurationId parameter is not present. String identifying the format of the Credential the Wallet needs. This Credential format identifier determines further claims in the authorization details object needed to identify the Credential type in the requested format.

locations

@SerialName(value = "locations")

val locations: Set<String>? = null

OID4VCI: If the Credential Issuer metadata contains an IssuerMetadata.authorizationServers parameter, the authorization detail's locations common data field MUST be set to the Credential Issuer Identifier value.

sdJwtVcType

@SerialName(value = "vct")

val sdJwtVcType: String? = null

OID4VCI: IETF SD-JWT VC: REQUIRED. String as defined in Appendix A.3.2. This claim contains the type values the Wallet requests authorization for at the Credential Issuer. It MUST only be present if the format claim is present. It MUST not be present otherwise.