IdxRemediation

Instances of IdxRemediation describe choices the user can make to proceed through the authentication workflow.

Either simple or complex authentication scenarios consist of a set of steps that may be followed, but at some times the user may have a choice in what they use to verify their identity. For example, a user may have multiple choices in verifying their account, such as:

  1. Password

  2. Security Questions

  3. Email verification

  4. Other customizable verification steps.

Each of the remediation options includes details about what form values should be collected from the user, and a description of the resulting request that should be sent to Okta to proceed to the next step.

Types

Link copied to clipboard
interface Capability

Marker interface for IdxRemediation capabilities.

Link copied to clipboard
class Form

Object that represents a form of fields associated with a remediation.

Link copied to clipboard

Enumeration describing the possible remediation types. This is expanded from the possible option values that may be present in the name property.

Properties

Link copied to clipboard

The set of authenticators associated with this remediation.

Link copied to clipboard
Link copied to clipboard

A description of the form values that this remediation option supports and expects.

Link copied to clipboard

The string name for this type.

Link copied to clipboard

The type of this remediation.

Functions

Link copied to clipboard
operator fun get(name: String): IdxRemediation.Form.Field?

Returns the field within this remediation with the given name or key-path.