0.0.0

oath/com.pingidentity.mfa.oath/OathCredential

OathCredential

@Serializable

data class OathCredential(val id: String = UUID.randomUUID().toString(), val userId: String? = null, val resourceId: String? = null, val issuer: String, val displayIssuer: String = issuer, val accountName: String, val displayAccountName: String = accountName, val oathType: OathType, val secret: String, val oathAlgorithm: OathAlgorithm = OathAlgorithm.SHA1, val digits: Int = 6, val period: Int = 30, val counter: Long = 0, val createdAt: Date = Date(), val imageURL: String? = null, val backgroundColor: String? = null, val policies: String? = null, var lockingPolicy: String? = null, var isLocked: Boolean = false)

Represents an OATH (TOTP/HOTP) credential. This model holds all necessary information to generate OTP codes and identify the credential.

Constructors

constructor(id: String = UUID.randomUUID().toString(), userId: String? = null, resourceId: String? = null, issuer: String, displayIssuer: String = issuer, accountName: String, displayAccountName: String = accountName, oathType: OathType, secret: String, oathAlgorithm: OathAlgorithm = OathAlgorithm.SHA1, digits: Int = 6, period: Int = 30, counter: Long = 0, createdAt: Date = Date(), imageURL: String? = null, backgroundColor: String? = null, policies: String? = null, lockingPolicy: String? = null, isLocked: Boolean = false)

Types

object Companion

Properties

val accountName: String

The account name (username) associated with this credential.

@Transient

val algorithm: String

The HMAC algorithm used as String.

backgroundColor

val backgroundColor: String? = null

Optional background color for the credential.

val counter: Long = 0

For HOTP, the counter value used to generate the next code.

@Serializable(with = DateSerializer::class)

val createdAt: Date

The timestamp when this credential was created.

val digits: Int = 6

The number of digits in the generated codes.

displayAccountName

val displayAccountName: String

The account name (username) associated with this credential, editable by the user.

val displayIssuer: String

The name of the issuer for this credential, editable by the user.

Unique identifier for the credential (local ID).

val imageURL: String? = null

Optional URL for the issuer's logo or image.

@EncodeDefault

var isLocked: Boolean

Indicates whether the credential is locked.

val issuer: String

The name of the issuer for this credential.

var lockingPolicy: String?

Optional lName of the Policy locking the credential.

@Serializable(with = OathAlgorithmSerializer::class)

val oathAlgorithm: OathAlgorithm

The HMAC algorithm used (SHA1, SHA256, SHA512).

@Serializable(with = OathTypeSerializer::class)

val oathType: OathType

The type of credential (TOTP or HOTP).

val period: Int = 30

For TOTP, the time period in seconds for which a code is valid.

val policies: String? = null

Optional Authenticator Policies in a JSON String format for the credential.

val resourceId: String? = null

Server-side device identifier.

val secret: String

The shared secret key used to generate OTP codes.

@Transient

val type: String

The type of credential (TOTP or HOTP) as String.

val userId: String? = null

User identifier on the server.

Functions

fun lockCredential(policyName: String)

Lock this credential due to policy violations.

fun toJson(): String

Converts this credential to a JSON string representation.

open override fun toString(): String

Returns a string representation of this credential.

suspend fun toUri(): String

Convert this credential to a URI string.

unlockCredential

fun unlockCredential()

Unlock this credential. Clears any locking policy information.