com.okta.authn.sdk.resource

Interface Options

All Superinterfaces:

com.okta.sdk.resource.ExtensibleResource, java.util.Map<java.lang.String,java.lang.Object>, com.okta.sdk.resource.PropertyRetriever, com.okta.sdk.resource.Resource

All Known Implementing Classes:

DefaultOptions

public interface Options
extends com.okta.sdk.resource.ExtensibleResource

Opt-in features for the authentication transaction.

Since:

0.1.0

Nested Class Summary

Nested classes/interfaces inherited from interface java.util.Map

java.util.Map.Entry<K,V>

Method Summary

Modifier and Type	Method and Description
java.lang.Boolean	isMultiOptionalFactorEnroll() Returns true if the user should transition back to MFA_ENROLL state after successful factor enrollment when additional optional factors are available for enrollment.
java.lang.Boolean	isWarnBeforePasswordExpired() Returns true if user should transition to PASSWORD_WARN state before SUCCESS if the user’s password is about to expire and within their password policy warn period.
Options	setMultiOptionalFactorEnroll(java.lang.Boolean multiOptionalFactorEnroll) Sets whether user should transaction back to MFA_ENROLL state after successful factor enrollment when additional optional factors are available for enrollment.
Options	setWarnBeforePasswordExpired(java.lang.Boolean warnBeforePasswordExpired) Sets whether if user should transition to PASSWORD_WARN state before SUCCESS if the user’s password is about to expire and within their password policy warn period.

Methods inherited from interface com.okta.sdk.resource.Resource

getResourceHref, setResourceHref

Methods inherited from interface com.okta.sdk.resource.PropertyRetriever

getBoolean, getInteger, getIntegerList, getNumber, getNumberList, getString, getStringList

Methods inherited from interface java.util.Map

clear, compute, computeIfAbsent, computeIfPresent, containsKey, containsValue, entrySet, equals, forEach, get, getOrDefault, hashCode, isEmpty, keySet, merge, put, putAll, putIfAbsent, remove, remove, replace, replace, replaceAll, size, values

Method Detail

isMultiOptionalFactorEnroll

java.lang.Boolean isMultiOptionalFactorEnroll()

Returns true if the user should transition back to MFA_ENROLL state after successful factor enrollment when additional optional factors are available for enrollment. (not required)

Returns:

true if user can enroll in multiple factors.

setMultiOptionalFactorEnroll

Options setMultiOptionalFactorEnroll(java.lang.Boolean multiOptionalFactorEnroll)

Sets whether user should transaction back to MFA_ENROLL state after successful factor enrollment when additional optional factors are available for enrollment. (not required)

Returns:

the current object for method chaining.

isWarnBeforePasswordExpired

java.lang.Boolean isWarnBeforePasswordExpired()

Returns true if user should transition to PASSWORD_WARN state before SUCCESS if the user’s password is about to expire and within their password policy warn period. (not required)

Returns:

true if user should warned about password expiration.

setWarnBeforePasswordExpired

Options setWarnBeforePasswordExpired(java.lang.Boolean warnBeforePasswordExpired)

Sets whether if user should transition to PASSWORD_WARN state before SUCCESS if the user’s password is about to expire and within their password policy warn period. (not required)

Returns:

the current object for method chaining.