okta-direct-auth/com.okta.directauth.model/OobChannel

OobChannel

Represents the channel for an Out-of-Band (OOB) authentication challenge.

OOB challenges are used in multi-factor authentication to send a code or a prompt to a user through a separate communication channel, such as SMS or email, to verify their identity.

Entries

PUSH

Specifies that the OOB challenge should be sent as a push notification to the user's registered device (e.g., via an authenticator app).

SMS

Specifies that the OOB challenge should be sent via SMS to the user's registered phone number.

VOICE

Specifies that the OOB challenge should be delivered via a voice call to the user's registered phone number.

Properties

entries

val entries: EnumEntries<OobChannel>

Returns a representation of an immutable list of all enum entries, in the order they're declared.

name

val name: String

ordinal

val ordinal: Int

value

val value: String

Functions

valueOf

fun valueOf(value: String): OobChannel

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

values

fun values(): Array<OobChannel>

Returns an array containing the constants of this enum type, in the order they're declared.