com.okta.idx.sdk.api.model

Class RemediationOption

java.lang.Object

com.okta.idx.sdk.api.model.RemediationOption

public class RemediationOption
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
RemediationOption()

Method Summary

Modifier and Type	Method and Description
FormValue[]	form() Get all form values.
java.util.Map<java.lang.String,java.lang.String>	getAuthenticatorOptions() Get a key-value pair map of Authenticator options available for the current remediation option.
java.lang.String	getHref()
java.lang.String	getName()
java.lang.String	getRefresh()
java.lang.String	getType()
IDXResponse	proceed(IDXClient client, java.lang.Object request) Allow you to continue the remediation with this option.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

RemediationOption

public RemediationOption()

Method Detail

proceed

public IDXResponse proceed(IDXClient client,
                           java.lang.Object request)
                    throws java.lang.IllegalStateException,
                           java.lang.IllegalArgumentException,
                           ProcessingException

Allow you to continue the remediation with this option.

Parameters:

client - the IDXClient instance

request - the request to Okta Identity Engine

Returns:

IDXResponse the response from Okta Identity Engine

Throws:

java.lang.IllegalArgumentException - MUST throw this exception when provided data does not contain all required data for the proceed call.

java.lang.IllegalStateException - MUST throw this exception when proceed is called with an invalid/unsupported request type.

ProcessingException - when the proceed operation encountered an execution/processing error.

form

public FormValue[] form()

Get all form values.

Returns:

array an array of FormValue

getName

public java.lang.String getName()

getType

public java.lang.String getType()

getHref

public java.lang.String getHref()

getRefresh

public java.lang.String getRefresh()

getAuthenticatorOptions

public java.util.Map<java.lang.String,java.lang.String> getAuthenticatorOptions()

Get a key-value pair map of Authenticator options available for the current remediation option. where key - authenticator type (e.g. password, security_question, email) value - authenticator id (e.g. aut2ihzk2n15tsQnQ1d6)

Returns:

map of Authenticator type and id