commonMain.at.asitplus.wallet.lib.oidvci.SupportedCredentialFormatDefinition.kt Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of vck-openid Show documentation

Kotlin Multiplatform library implementing the W3C VC Data Model, with OpenId protocol implementations

The newest version!

package at.asitplus.wallet.lib.oidvci

import at.asitplus.wallet.lib.oidvci.mdl.RequestedCredentialClaimSpecification
import kotlinx.serialization.SerialName
import kotlinx.serialization.Serializable

/**
 * OID4VCI: W3C VC:  REQUIRED. Object containing the detailed description of the Credential type.
 * It consists of at least the following two parameters: `type, `credentialSubject`.
 */
@Serializable
data class SupportedCredentialFormatDefinition(

    /**
     * OID4VCI: W3C VC: REQUIRED. JSON array designating the types a certain credential type supports
     * according to (VC_DATA), Section 4.3, e.g. `VerifiableCredential`, `UniversityDegreeCredential`
     */
    @SerialName("type")
    val types: Collection? = null,

    /**
     * OID4VCI:
     * W3C VC: OPTIONAL. Object containing a list of name/value pairs, where each name identifies
     * a claim offered in the Credential. The value can be another such object (nested data structures), or an array
     * of such objects
     */
    @SerialName("credentialSubject")
    val credentialSubject: Map? = null,

    // TODO is present in EUDIW issuer ... but is this really valid?
    @SerialName("claims")
    val claims: Map? = null,
)