0.0.0

push/com.pingidentity.mfa.push/PushCredential

PushCredential

@Serializable

data class PushCredential(val id: String = UUID.randomUUID().toString(), val userId: String? = null, val resourceId: String = UUID.randomUUID().toString(), val issuer: String, val displayIssuer: String = issuer, val accountName: String, val displayAccountName: String = accountName, val serverEndpoint: String, val sharedSecret: String, val createdAt: Date = Date(), val imageURL: String? = null, val backgroundColor: String? = null, val policies: String? = null, var lockingPolicy: String? = null, var isLocked: Boolean = false, val platform: String = PushPlatform.PING_AM.name)

Represents a push credential for receiving push notifications. This model holds all necessary information to identify and interact with push notifications.

Constructors

constructor(id: String = UUID.randomUUID().toString(), userId: String? = null, resourceId: String = UUID.randomUUID().toString(), issuer: String, displayIssuer: String = issuer, accountName: String, displayAccountName: String = accountName, serverEndpoint: String, sharedSecret: String, createdAt: Date = Date(), imageURL: String? = null, backgroundColor: String? = null, policies: String? = null, lockingPolicy: String? = null, isLocked: Boolean = false, platform: String = PushPlatform.PING_AM.name)

Types

object Companion

Properties

val accountName: String

The account name (username) associated with this credential. Should be unique per user.

authenticationEndpoint

val authenticationEndpoint: String

Returns the authentication endpoint for this credential. This is used to authenticate the user via push notification with the PingAM servers.

backgroundColor

val backgroundColor: String? = null

Optional background color for the credential.

@Serializable(with = DateSerializer::class)

val createdAt: Date

The timestamp when this credential was created.

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. Should be a unique identifier for the service or application issuing the credential.

var lockingPolicy: String?

Optional name of the Policy locking the credential.

val platform: String

The platform for which this credential is intended (e.g., PING_AM).

val policies: String? = null

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

registrationEndpoint

val registrationEndpoint: String

Returns the registration endpoint for this credential. This is used to register the device with the PingAM servers.

val resourceId: String

Server-side device identifier. Default to id if resourceId is not provided. In PingAM, resourceId is the same as the local id.

val serverEndpoint: String

The endpoint where authentication responses should be sent.

val sharedSecret: String

The secret key used for cryptographic operations.

val updateEndpoint: String

Returns the update endpoint for this credential. This is used to refresh or update the device token with the PingAM servers.

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.

unlockCredential

fun unlockCredential()

Unlock this credential. Clears any locking policy information.