idx-kotlin/com.okta.idx.kotlin.dto/IdxRemediation/Form/Field

Field

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

Functions

get

operator fun get(name: String): IdxRemediation.Form.Field?

Returns the nested form field with the given name.

Properties

authenticator

val authenticator: IdxAuthenticator?

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.

form

val form: IdxRemediation.Form?

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

isMutable

val isMutable: Boolean

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

isRequired

val isRequired: Boolean

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

isSecret

val isSecret: Boolean

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

label

val label: String?

The user-readable label describing this form value.

messages

val messages: IdxMessageCollection

The list of messages sent from the server.

name

val name: String?

The programmatic name for this form value.

options

val options: List<IdxRemediation.Form.Field>?

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.

selectedOption

@Volatile

var selectedOption: IdxRemediation.Form.Field? = null

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

type

val type: String

The type of value expected from the client.

value

var value: Any?

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