okta-idx-kotlin/com.okta.idx.kotlin.dto/IdxResponse

IdxResponse

Describes the response from an Okta Identity Engine workflow stage. This is used to determine the current state of the workflow, the set of available remediation steps to proceed through the workflow, actions that can be performed, and other information relevant to the authentication of a user.

Types

Intent

enum Intent : Enum<IdxResponse.Intent>

The intent of the authentication workflow, as returned from the server.

Properties

app

val app: IdxApplication?

Returns information about the application, if available.

authenticators

val authenticators: IdxAuthenticatorCollection

Contains information about the available authenticators.

expiresAt

val expiresAt: Date?

The date at which this stage of the workflow expires, after which the authentication process should be restarted.

intent

val intent: IdxResponse.Intent

A string describing the intent of the workflow, e.g. "LOGIN".

isLoginSuccessful

val isLoginSuccessful: Boolean

Indicates whether or not the user has logged in successfully. If this is true, this response object should be exchanged for access tokens utilizing the exchangeCode method.

messages

val messages: IdxMessageCollection

The list of messages sent from the server. Messages reported from the server are usually errors, but may include other information relevant to the user. They should be displayed to the user in the context of the remediation form itself.

remediations

val remediations: IdxRemediationCollection

An object describing the sort of remediation steps available to the user.

user

val user: IdxUser?

Returns information about the user authenticating, if available.