Properties

Link copied to clipboard

List of claims that may be issued separately when requested in format ConstantIndex.CredentialRepresentation.SD_JWT or ConstantIndex.CredentialRepresentation.ISO_MDOC.

Link copied to clipboard

Whether every claim path already includes its ISO namespace. Qualified paths are preserved even when their namespace differs from isoNamespace. Defaults to false for schemes sharing relative paths across formats.

Link copied to clipboard
abstract override val isoDocType: String

From ISO/IEC 18013-5: There is no requirement for the DocType format. An approach to avoid collisions is to use the following general format: [Reverse Domain].[Domain Specific Extension].

Link copied to clipboard
abstract override val isoNamespace: String

From ISO/IEC 18013-5: There is no requirement for the NameSpace format. An approach to avoid collisions is to use the following general format: [Reverse Domain].[Domain Specific Extension].

Link copied to clipboard

The claimDescriptions with paths qualified by the isoNamespace, as the claims of an ISO mdoc are: multi-format schemes (e.g. ConstantIndex.AtomicAttribute2023) share JSON-style claim descriptions across representations, so the namespace is prefixed unless the path already starts with it. When IsoMdocCredentialScheme.isoClaimPathsAreQualified is true, every path is preserved, independently of the scheme namespace. Metadata-derived schemes use qualified paths.

Link copied to clipboard
open val sdJwtType: String?

Type used for vct when using ConstantIndex.CredentialRepresentation.SD_JWT.

Link copied to clipboard

Supported representations for this credential. Note that this is usually only one representation, and should be replaced with the typed implementations of the interface CredentialScheme.

Link copied to clipboard
open val vcType: String?

The type of the credential when using ConstantIndex.CredentialRepresentation.PLAIN_JWT. Will not be used for other representations. Previously this has been used as the subtype of CredentialSubject, but this class has been removed.

Functions

Link copied to clipboard
fun CredentialScheme.requiredClaims(credentialIdentifier: String, representation: ConstantIndex.CredentialRepresentation, source: String? = null): RequiredClaims

The claims of the credential type credentialIdentifier that this scheme describes as mandatory, each with the closest ancestor described as optional as its RequiredClaim.condition. For ISO_MDOC, paths are qualified with the ISO namespace, see isoQualifiedClaimDescriptions.