openid-data-classes/at.asitplus.openid/CredentialRequestParameters

CredentialRequestParameters

@Serializable

data class CredentialRequestParameters(val credentialIdentifier: String? = null, val format: CredentialFormatEnum? = null, val credentialResponseEncryption: SupportedAlgorithmsContainer? = null, val docType: String? = null, val claims: Map<String, Map<String, RequestedCredentialClaimSpecification>>? = null, val credentialDefinition: SupportedCredentialFormatDefinition? = null, val sdJwtVcType: String? = null, val proof: CredentialRequestProof? = null, val proofs: CredentialRequestProofContainer? = null)(source)

Constructors

constructor(credentialIdentifier: String? = null, format: CredentialFormatEnum? = null, credentialResponseEncryption: SupportedAlgorithmsContainer? = null, docType: String? = null, claims: Map<String, Map<String, RequestedCredentialClaimSpecification>>? = null, credentialDefinition: SupportedCredentialFormatDefinition? = null, sdJwtVcType: String? = null, proof: CredentialRequestProof? = null, proofs: CredentialRequestProofContainer? = null)

Types

Companion

object Companion

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).

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.

credentialIdentifier

@SerialName(value = "credential_identifier")

val credentialIdentifier: String? = null

OID4VCI: REQUIRED when an AuthorizationDetails.OpenIdCredential was returned from the TokenResponseParameters. It MUST NOT be used otherwise. A string that identifies a Credential Dataset that is requested for issuance. When this parameter is used, the format parameter and any other Credential format specific parameters such as those defined in Appendix A MUST NOT be present

credentialResponseEncryption

@SerialName(value = "credential_response_encryption")

val credentialResponseEncryption: SupportedAlgorithmsContainer? = null

OID4VCI: OPTIONAL. Object containing information for encrypting the Credential Response. If this request element is not present, the corresponding credential response returned is not encrypted.

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 if an AuthorizationDetails.OpenIdCredential was not returned from the TokenResponseParameters (e.g. when the credential was requested using a AuthenticationRequestParameters.scope or a pre-authorisation code was used that did not return an AuthorizationDetails.OpenIdCredential). It MUST NOT be used otherwise. A string that determines the format of the Credential to be issued, which may determine the type and any other information related to the Credential to be issued. Credential Format Profiles consist of the Credential format specific parameters that are defined in Appendix A. When this parameter is used, the credentialIdentifier parameter MUST NOT be present.

proof

@SerialName(value = "proof")

val proof: CredentialRequestProof? = null

OID4VCI: OPTIONAL. Object providing a single proof of possession of the cryptographic key material to which the issued Credential instance will be bound to. proof parameter MUST NOT be present if proofs parameter is used.

proofs

@SerialName(value = "proofs")

val proofs: CredentialRequestProofContainer? = null

OID4VCI: OPTIONAL. Object providing one or more proof of possessions of the cryptographic key material to which the issued Credential instances will be bound to. The proofs parameter MUST NOT be present if proof parameter is used. proofs object contains exactly one parameter named as the proof type in Section 7.2.1, the value set for this parameter is an array containing parameters as defined by the corresponding proof type.

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.

Functions

serialize

fun serialize(): String