rqes-data-classes/at.asitplus.rqes/CredentialListRequest

CredentialListRequest

@Serializable

data class CredentialListRequest( val userID: String? = null, val credentialInfo: Boolean? = false, val certificates: CertificateOptions? = CertificateOptions.SINGLE, val certInfo: Boolean? = false, val authInfo: Boolean? = false, val onlyValid: Boolean? = false, val lang: String? = null, val clientData: String? = null)(source)

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

Constructors

constructor( userID: String? = null, credentialInfo: Boolean? = false, certificates: CertificateOptions? = CertificateOptions.SINGLE, certInfo: Boolean? = false, authInfo: Boolean? = false, onlyValid: Boolean? = false, lang: String? = null, clientData: String? = null)

Properties

authInfo

@SerialName(value = "authInfo")

val authInfo: Boolean? = false

Request to return various parameters containing information on the authorization mechanisms supported by the corresponding credential (auth group). The default value is “false”

certificates

@SerialName(value = "certificates")

val certificates: CertificateOptions?

CSC OPTIONAL-CONDITIONAL. Specifies which certificates from the certificate chain SHALL be returned The default value is CertificateOptions.SINGLE

certInfo

@SerialName(value = "certInfo")

val certInfo: Boolean? = false

Request to return various parameters containing information from the end entity certificate(s). The default value is Boolean.false

clientData

@SerialName(value = "clientData")

val clientData: String? = null

Arbitrary data from the signature application. It can be used to handle a transaction identifier or other application-spe cific data that may be useful for debugging purposes

credentialInfo

@SerialName(value = "credentialInfo")

val credentialInfo: Boolean? = false

CSC OPTIONAL. Request to return the main information included in the public key certificate and the public key certificate itself or the certificate chain associated to the credentials. The default value is Boolean.false

lang

@SerialName(value = "lang")

val lang: String? = null

Request a preferred language of the response to the remote service

onlyValid

@SerialName(value = "onlyValid")

val onlyValid: Boolean? = false

Request to return only credentials usable to create a valid signature. The default value is “false”

userID

@SerialName(value = "userID")

val userID: String? = null

CSC REQUIRED-CONDITIONAL. The identifier associated to the identity of the credential owner. This parameter SHALL NOT be present if the service authorization is user-specific (see NOTE below). In that case the userID is already implicit in the service access token passed in the Authorization header.