Field

class Field

Describes an individual field within a form, used to collect and submit information from the user to proceed through the authentication workflow.

Properties

Link copied to clipboard

Relates this field to an authenticator, when a field is used to represent an authenticator. For example, when a field is used within a series of options to identify which authenticator to select.

Link copied to clipboard

For composite form fields, this contains the nested array of form values to group together.

Link copied to clipboard

Indicates whether or not the form value is read-only.

Link copied to clipboard

Indicates whether or not the form value is required to successfully proceed through this remediation option.

Link copied to clipboard

Indicates whether or not the value supplied in this form value should be considered secret, and not presented to the user.

Link copied to clipboard

The user-readable label describing this form value.

Link copied to clipboard

The list of messages sent from the server.

Link copied to clipboard
val name: String?

The programmatic name for this form value.

Link copied to clipboard

For form fields that have specific options the user can choose from (e.g. security question, passcode, etc), this indicates the different form options that should be displayed to the user.

Link copied to clipboard

Allows a developer to set the selected option for a field that contains multiple options.

Link copied to clipboard

The type of value expected from the client.

Link copied to clipboard
var value: Any?

The value to send, if a default is provided from the Identity Engine.

Functions

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

Returns the nested form field with the given name.