csc-data-classes/at.asitplus.csc.api/CredentialInfo

CredentialInfo

@Serializable

data class CredentialInfo(val credentialID: String? = null, val description: String? = null, val signatureQualifier: SignatureQualifier? = null, val keyParameters: KeyParameters, val certParameters: CertificateParameters? = null, val authParameters: AuthParameters? = null, val scal: CredentialInfo.ScalOptions? = ScalOptions.SCAL1, val multisign: UInt, val lang: String? = null)(source)

Data class that implements credentialInfo class defined in CSC-API v2.0.0.2 Ch. 11.4 "credentials/list" and Ch. 11.5 "credentials/info"

Constructors

CredentialInfo

constructor(credentialID: String? = null, description: String? = null, signatureQualifier: SignatureQualifier? = null, keyParameters: KeyParameters, certParameters: CertificateParameters? = null, authParameters: AuthParameters? = null, scal: CredentialInfo.ScalOptions? = ScalOptions.SCAL1, multisign: UInt, lang: String? = null)

Types

ScalOptions

enum ScalOptions : Enum<CredentialInfo.ScalOptions>

Properties

authParameters

@SerialName(value = "auth")

val authParameters: AuthParameters?

Details about the authentication method

certParameters

@SerialName(value = "cert")

val certParameters: CertificateParameters?

CSC REQUIRED-CONDITIONAL. May be required depending on the CredentialInfoRequest Contains information about the certificate associated with the credential

credentialID

@SerialName(value = "credentialID")

val credentialID: String?

CSC In case of credentials/list credentialID is REQUIRED. In case this is a credentials/info response credentialID is not defined.

description

@SerialName(value = "description")

val description: String?

CSC OPTIONAL. A free form description of the credential in the lang language. The maximum size of the string is 255 characters.

keyParameters

@SerialName(value = "key")

val keyParameters: KeyParameters

CSC REQUIRED. Status and attributes of key.

lang

@SerialName(value = "lang")

val lang: String?

Preferred language

multisign

@SerialName(value = "multisign")

val multisign: UInt

A number equal or higher to 1 representing the maximum number of signatures that can be created with this credential with a single authorization request

multisignAsLong

val multisignAsLong: Long

Java-safe accessor for multisign.

scal

@SerialName(value = "SCAL")

val scal: CredentialInfo.ScalOptions?

Specifies if the RSSP will generate for this credential a signature activation data (SAD) or an access token with scope “credential” that contains a link to the hash to-be-signed This value is OPTIONAL and the default value is “1”.

signatureQualifier

@SerialName(value = "signatureQualifier")

val signatureQualifier: SignatureQualifier?

CSC OPTIONAL. Identifier qualifying the type of signature this credential is suitable for