Options (Okta Authn SDK 2.0.1-SNAPSHOT API)

All Superinterfaces:

com.okta.sdk.resource.ExtensibleResource, Map<String,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
  Map.Entry<K extends Object,V extends Object>

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`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.
`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(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(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 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

Methods inherited from interface com.okta.sdk.resource.PropertyRetriever
getBoolean, getInteger, getIntegerList, getNumber, getNumberList, getString, getStringList

Methods inherited from interface com.okta.sdk.resource.Resource
getResourceHref, setResourceHref

- Method Detail
  - isMultiOptionalFactorEnroll
```
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(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
```
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(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.