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

Package-level declarations

Types

DCQLClaimsPathPointer

@Serializable(with = DCQLClaimsPathPointerInlineSerializer::class)

class DCQLClaimsPathPointer(val segments: NonEmptyList<DCQLClaimsPathPointerSegment>) : List<DCQLClaimsPathPointerSegment>

6.4. Claims Path Pointer

DCQLClaimsPathPointerInlineSerializer

object DCQLClaimsPathPointerInlineSerializer : KSerializer<DCQLClaimsPathPointer>

DCQLClaimsPathPointerNullSegmentSerializer

object DCQLClaimsPathPointerNullSegmentSerializer : KSerializer<DCQLClaimsPathPointerSegment.NullSegment>

DCQLClaimsPathPointerSegment

@Serializable(with = DCQLClaimsPathPointerSegmentSerializer::class)

sealed interface DCQLClaimsPathPointerSegment

DCQLClaimsPathPointerSegmentSerializer

object DCQLClaimsPathPointerSegmentSerializer : KSerializer<DCQLClaimsPathPointerSegment>

DCQLClaimsQuery

@Serializable(with = DCQLClaimsQuerySerializer::class)

interface DCQLClaimsQuery

DCQLClaimsQueryIdentifier

@Serializable

value class DCQLClaimsQueryIdentifier(val string: String)

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.

DCQLClaimsQueryList

@Serializable

value class DCQLClaimsQueryList<out DCQLClaimsQueryType : DCQLClaimsQuery>(list: NonEmptyList<DCQLClaimsQueryType>) : List<DCQLClaimsQueryType>

A non-empty array of objects as defined in Section 6.3 that specifies claims in the requested Credential.

DCQLClaimsQueryResult

sealed interface DCQLClaimsQueryResult

DCQLClaimsQuerySerializer

object DCQLClaimsQuerySerializer : JsonContentPolymorphicSerializer<DCQLClaimsQuery>

DCQLCredentialClaimStructure

sealed interface DCQLCredentialClaimStructure

DCQLCredentialMetadataAndValidityConstraints

@Serializable(with = DCQLCredentialMetadataAndValidityConstraintsSerializer::class)

interface DCQLCredentialMetadataAndValidityConstraints

DCQLCredentialMetadataAndValidityConstraintsSerializer

object DCQLCredentialMetadataAndValidityConstraintsSerializer : JsonContentPolymorphicSerializer<DCQLCredentialMetadataAndValidityConstraints>

DCQLCredentialQuery

@Serializable(with = DCQLCredentialQuerySerializer::class)

sealed interface DCQLCredentialQuery

DCQLCredentialQueryIdentifier

@Serializable

value class DCQLCredentialQueryIdentifier(val string: String)

A string identifying the Credential in the response and, if provided, the constraints in credential_sets. The value MUST be a non-empty string consisting of alphanumeric, underscore (_) or hyphen (-) characters. Within the Authorization Request, the same id MUST NOT be present more than once.

DCQLCredentialQueryInstance

@Serializable

data class DCQLCredentialQueryInstance(val id: DCQLCredentialQueryIdentifier, val format: CredentialFormatEnum, val meta: DCQLCredentialMetadataAndValidityConstraints? = null, val claims: DCQLClaimsQueryList<DCQLClaimsQuery>? = null, val claimSets: NonEmptyList<List<DCQLClaimsQueryIdentifier>>? = null) : DCQLCredentialQuery

DCQLCredentialQueryList

@Serializable

value class DCQLCredentialQueryList<out DCQLCredentialQueryType : DCQLCredentialQuery>(list: NonEmptyList<DCQLCredentialQueryType>) : List<DCQLCredentialQueryType>

Relevant references: OID4VP draft 23: A non-empty array of Credential Queries as defined in Section 6.1 that specify the requested Verifiable Credentials.

DCQLCredentialQueryMatchingResult

sealed interface DCQLCredentialQueryMatchingResult

DCQLCredentialQuerySerializer

object DCQLCredentialQuerySerializer : JsonContentPolymorphicSerializer<DCQLCredentialQuery>

DCQLCredentialSetQuery

@Serializable

data class DCQLCredentialSetQuery(val options: NonEmptyList<List<DCQLCredentialQueryIdentifier>>, val required: Boolean = true, val purpose: DCQLCredentialSetQueryPurpose? = null)

6.2. Credential Set Query

DCQLCredentialSetQueryPurpose

@Serializable(with = DCQLCredentialSetQueryPurposeSerializer::class)

sealed interface DCQLCredentialSetQueryPurpose

DCQLCredentialSetQueryPurposeSerializer

object DCQLCredentialSetQueryPurposeSerializer : KSerializer<DCQLCredentialSetQueryPurpose>

DCQLCredentialSubmissionOption

@Serializable

data class DCQLCredentialSubmissionOption<Credential : Any>(val credential: Credential, val matchingResult: DCQLCredentialQueryMatchingResult)

DCQLExpectedClaimValue

@Serializable(with = DCQLExpectedClaimValueSerializer::class)

sealed interface DCQLExpectedClaimValue

DCQLExpectedClaimValueSerializer

object DCQLExpectedClaimValueSerializer : KSerializer<DCQLExpectedClaimValue>

DCQLIsoMdocClaimsQuery

@Serializable

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

DCQLIsoMdocCredentialMetadataAndValidityConstraints

@Serializable

data class DCQLIsoMdocCredentialMetadataAndValidityConstraints(val doctypeValue: String?) : DCQLCredentialMetadataAndValidityConstraints

DCQLIsoMdocCredentialQuery

@Serializable

data class DCQLIsoMdocCredentialQuery(val id: DCQLCredentialQueryIdentifier, val format: CredentialFormatEnum, val meta: DCQLIsoMdocCredentialMetadataAndValidityConstraints? = null, val claims: DCQLClaimsQueryList<DCQLIsoMdocClaimsQuery>? = null, val claimSets: NonEmptyList<List<DCQLClaimsQueryIdentifier>>? = null) : DCQLCredentialQuery

DCQLJsonClaimsQuery

@Serializable

data class DCQLJsonClaimsQuery(val id: DCQLClaimsQueryIdentifier? = null, val values: List<DCQLExpectedClaimValue>? = null, val path: DCQLClaimsPathPointer) : DCQLClaimsQuery

@Serializable

data class DCQLQuery(val credentials: DCQLCredentialQueryList<DCQLCredentialQuery>, val credentialSets: NonEmptyList<DCQLCredentialSetQuery>? = null)

DCQLQueryResult

data class DCQLQueryResult<Credential : Any>(val credentialQueryMatches: Map<DCQLCredentialQueryIdentifier, List<DCQLCredentialSubmissionOption<Credential>>>, val satisfiableCredentialSetQueries: List<DCQLCredentialSetQuery>)

DCQLSdJwtCredentialMetadataAndValidityConstraints

@Serializable

data class DCQLSdJwtCredentialMetadataAndValidityConstraints(val vctValues: List<String>?) : DCQLCredentialMetadataAndValidityConstraints

DCQLSdJwtCredentialQuery

@Serializable

data class DCQLSdJwtCredentialQuery(val id: DCQLCredentialQueryIdentifier, val format: CredentialFormatEnum, val meta: DCQLSdJwtCredentialMetadataAndValidityConstraints? = null, val claims: DCQLClaimsQueryList<DCQLJsonClaimsQuery>? = null, val claimSets: NonEmptyList<List<DCQLClaimsQueryIdentifier>>? = null) : DCQLCredentialQuery

6.1. Credential Query