openid-data-classes/at.asitplus.openid.dcql/DCQLIsoMdocClaimsQuery

DCQLIsoMdocClaimsQuery

@Serializable

data class DCQLIsoMdocClaimsQuery( val id: DCQLClaimsQueryIdentifier? = null, val values: List<DCQLExpectedClaimValue>? = null, val namespace: String, val claimName: String) : DCQLClaimsQuery(source)

Constructors

constructor(id: DCQLClaimsQueryIdentifier? = null, values: List<DCQLExpectedClaimValue>? = null, namespace: String, claimName: String)

Types

SerialNames

object SerialNames

Properties

claimName

@SerialName(value = "claim_name")

val claimName: String

OID4VP draft 23: claim_name: REQUIRED if the Credential Format is based on mdoc format defined in ISO.18013-5; MUST NOT be present otherwise. The value MUST be a string that specifies the data element identifier of the data element within the provided namespace in the mdoc, e.g., first_name.

@SerialName(value = "id")

open override val id: DCQLClaimsQueryIdentifier? = null

OID4VP draft 23: id: REQUIRED if claim_sets is present in the Credential Query; OPTIONAL otherwise. A string identifying the particular claim. The value MUST be a non-empty string consisting of alphanumeric, underscore (_) or hyphen (-) characters. Within the particular claims array, the same id MUST NOT be present more than once.

namespace

@SerialName(value = "namespace")

val namespace: String

OID4VP draft 23: namespace: REQUIRED if the Credential Format is based on the mdoc format defined in ISO.18013-5; MUST NOT be present otherwise. The value MUST be a string that specifies the namespace of the data element within the mdoc, e.g., org.iso.18013.5.1.

values

@SerialName(value = "values")

open override val values: List<DCQLExpectedClaimValue>? = null

OID4VP draft 23: values: OPTIONAL. An array of strings, integers or boolean values that specifies the expected values of the claim. If the values property is present, the Wallet SHOULD return the claim only if the type and value of the claim both match for at least one of the elements in the array. Details of the processing rules are defined in Section 6.3.1.1.

Functions

executeClaimsQueryAgainstCredential

open fun <Credential : Any> executeClaimsQueryAgainstCredential( credentialQuery: DCQLCredentialQuery, credential: Credential, credentialStructureExtractor: (Credential) -> DCQLCredentialClaimStructure): KmmResult<DCQLClaimsQueryResult>

executeIsoMdocClaimsQueryAgainstCredential

fun <Credential : Any> executeIsoMdocClaimsQueryAgainstCredential( credentialQuery: DCQLCredentialQuery, credential: Credential, credentialStructureExtractor: (Credential) -> DCQLCredentialClaimStructure.IsoMdocStructure): KmmResult<DCQLClaimsQueryResult.IsoMdocResult>

6.3.1.1. Selecting Claims