rqes-data-classes/at.asitplus.rqes.collection_entries/AuthParameters

AuthParameters

@Serializable
data class AuthParameters(val mode: AuthParameters.AuthMode, val expression: String? = null, val objects: Collection<JsonObject>? = null)(source)

CSC-API v2.0.0.2 Part of CredentialInfo

Constructors

Link copied to clipboard
constructor(mode: AuthParameters.AuthMode, expression: String? = null, objects: Collection<JsonObject>? = null)

Types

Link copied to clipboard
enum AuthExpressionOptions : Enum<AuthParameters.AuthExpressionOptions>

Defines logic of expression string Example: "PIN AND OTP" with PIN and OTP then being defined in objects TODO: NOT IMPLEMENTED

Link copied to clipboard

Properties

Link copied to clipboard
@SerialName(value = "expression")
val expression: String? = null

OPTIONAL-CONDITIONAL. An expression defining the combination of authentication objects required to authorize usage of the private key. If empty, an “AND” of all authentication objects is implied. Supported operators are: “AND” | “OR” | “XOR” | “(” | “)” This value SHALL NOT be returned if mode is not AuthMode.EXPLICIT.

Link copied to clipboard
@SerialName(value = "mode")
val mode: AuthParameters.AuthMode

REQUIRED. Specifies one of the authorization modes.

Link copied to clipboard
@SerialName(value = "objects")
val objects: Collection<JsonObject>? = null

REQUIRED-CONDITIONAL. The authentication object types available for this credential. authentication This value SHALL only be returned if mode is AuthMode.EXPLICIT.