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

DCQLCredentialQuery

@Serializable(with = DCQLCredentialQuerySerializer::class)
sealed interface DCQLCredentialQuery(source)

Inheritors

Types

Link copied to clipboard
object Companion

Properties

Link copied to clipboard
abstract val claims: DCQLClaimsQueryList<DCQLClaimsQuery>?

OID4VP draft 23: claims: OPTIONAL. A non-empty array of objects as defined in Section 6.3 that specifies claims in the requested Credential.

Link copied to clipboard
abstract val claimSets: NonEmptyList<List<DCQLClaimsQueryIdentifier>>?

OID4VP draft 23: claim_sets: OPTIONAL. A non-empty array containing arrays of identifiers for elements in claims that specifies which combinations of claims for the Credential are requested. The rules for selecting claims to send are defined in Section 6.3.1.1.

Link copied to clipboard
abstract val format: CredentialFormatEnum

OID4VP draft 23: format: REQUIRED. A string that specifies the format of the requested Verifiable Credential. Valid Credential Format Identifier values are defined in Appendix B.

Link copied to clipboard
abstract val id: DCQLCredentialQueryIdentifier

OID4VP draft 23: id: REQUIRED. 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.

Link copied to clipboard
abstract val meta: DCQLCredentialMetadataAndValidityConstraints?

OID4VP draft 23: meta: OPTIONAL. An object defining additional properties requested by the Verifier that apply to the metadata and validity data of the Credential. The properties of this object are defined per Credential Format. Examples of those are in Appendix B.4.3.1 and Appendix B.3.1.1. If omitted, no specific constraints are placed on the metadata or validity of the requested Credential.

Functions

Link copied to clipboard
open fun <Credential : Any> executeCredentialQueryAgainstCredential(    credential: Credential,     credentialFormatExtractor: (Credential) -> CredentialFormatEnum,     mdocCredentialDoctypeExtractor: (Credential) -> String,     sdJwtCredentialTypeExtractor: (Credential) -> String,     credentialClaimStructureExtractor: (Credential) -> DCQLCredentialClaimStructure): KmmResult<DCQLCredentialQueryMatchingResult>

6.3.1.1. Selecting Claims