com.okta.sdk.impl.resource.user.factor

Class DefaultUserFactor

java.lang.Object

com.okta.sdk.impl.resource.AbstractPropertyRetriever

com.okta.sdk.impl.resource.AbstractResource

com.okta.sdk.impl.resource.AbstractInstanceResource<UserFactor>

com.okta.sdk.impl.resource.user.factor.DefaultUserFactor

All Implemented Interfaces:

Deletable, ExtensibleResource, PropertyRetriever, Resource, Saveable<UserFactor>, UserFactor, Map<String,Object>

Direct Known Subclasses:

DefaultCallUserFactor, DefaultCustomHotpUserFactor, DefaultEmailUserFactor, DefaultHardwareUserFactor, DefaultPushUserFactor, DefaultSecurityQuestionUserFactor, DefaultSmsUserFactor, DefaultTokenUserFactor, DefaultTotpUserFactor, DefaultU2fUserFactor, DefaultWebAuthnUserFactor, DefaultWebUserFactor

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2023-07-07T09:07:53.917-05:00")
public class DefaultUserFactor
extends AbstractInstanceResource<UserFactor>
implements UserFactor

UserFactor

Nested Class Summary

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

Map.Entry<K,V>

Field Summary

Fields inherited from class com.okta.sdk.impl.resource.AbstractResource

properties

Fields inherited from class com.okta.sdk.impl.resource.AbstractPropertyRetriever

readLock, writeLock

Constructor Summary

Constructors

Constructor and Description
DefaultUserFactor(InternalDataStore dataStore)
DefaultUserFactor(InternalDataStore dataStore, Map<String,Object> properties)

Method Summary

Modifier and Type	Method and Description
UserFactor	activate() Activate Factor The `sms` and `token:software:totp` factor types require activation to complete the enrollment process.
UserFactor	activate(ActivateFactorRequest body) Activate Factor The `sms` and `token:software:totp` factor types require activation to complete the enrollment process.
void	delete() Unenrolls an existing factor for the specified user, allowing the user to enroll a new factor.
Date	getCreated()
Map<String,Object>	getEmbedded()
FactorType	getFactorType()
String	getId()
Date	getLastUpdated()
Map<String,Object>	getLinks()
Map<String,Property>	getPropertyDescriptors()
FactorProvider	getProvider()
Class<? extends Resource>	getResourceClass() Returns the class this resource represents.
FactorStatus	getStatus()
VerifyFactorRequest	getVerify()
UserFactor	setFactorType(FactorType factorType)
UserFactor	setProvider(FactorProvider provider)
UserFactor	setVerify(VerifyFactorRequest verify)
VerifyUserFactorResponse	verify() Verify MFA Factor Verifies an OTP for a `token` or `token:hardware` factor
VerifyUserFactorResponse	verify(VerifyFactorRequest body, String templateId, Integer tokenLifetimeSeconds, String xForwardedFor, String userAgent, String acceptLanguage) Verify MFA Factor Verifies an OTP for a `token` or `token:hardware` factor

Methods inherited from class com.okta.sdk.impl.resource.AbstractInstanceResource

save

Methods inherited from class com.okta.sdk.impl.resource.AbstractResource

clear, containsKey, containsValue, createPropertyDescriptorMap, createPropertyDescriptorMap, entrySet, equals, get, getDataStore, getDeletedPropertyNames, getInternalProperties, getParamsFromHref, getProperty, getPropertyNames, getResourceHref, getResourceListProperty, getResourceProperty, getUpdatedPropertyNames, hashCode, hasProperty, isDirty, isEmpty, isPrintableProperty, keySet, materialize, put, putAll, remove, setInternalProperties, setProperty, setProperty, setResourceHref, size, toString, values

Methods inherited from class com.okta.sdk.impl.resource.AbstractPropertyRetriever

getBoolean, getBoolean, getBooleanProperty, getCharArray, getDateProperty, getDoubleProperty, getDoubleProperty, getEnumListProperty, getEnumProperty, getEnumProperty, getInt, getInteger, getIntegerList, getIntProperty, getIntProperty, getListProperty, getListProperty, getMap, getMapProperty, getNonEmptyMap, getNullableBoolean, getNullableBooleanProperty, getNumber, getNumberList, getString, getString, getStringList, getStringProperty, setProperty, setProperty

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

Constructor Detail

DefaultUserFactor

public DefaultUserFactor(InternalDataStore dataStore)

DefaultUserFactor

public DefaultUserFactor(InternalDataStore dataStore,
                         Map<String,Object> properties)

Method Detail

getPropertyDescriptors

public Map<String,Property> getPropertyDescriptors()

Specified by:

getPropertyDescriptors in class AbstractResource

getResourceClass

public Class<? extends Resource> getResourceClass()

Description copied from class: AbstractInstanceResource

Returns the class this resource represents. This is used when you need to figure out what the main type of Resource this object is. For example, DefaultFoo, ImplFoo, and SuperFoo may all represent the Resource of Foo, in this case this method may return Foo.class. (Defaults to getClass().)

Overrides:

getResourceClass in class AbstractInstanceResource<UserFactor>

Returns:

The type of resource this class represents.

getEmbedded

public Map<String,Object> getEmbedded()

Specified by:

getEmbedded in interface UserFactor

getLinks

public Map<String,Object> getLinks()

Specified by:

getLinks in interface UserFactor

getCreated

public Date getCreated()

Specified by:

getCreated in interface UserFactor

getFactorType

public FactorType getFactorType()

Specified by:

getFactorType in interface UserFactor

setFactorType

public UserFactor setFactorType(FactorType factorType)

Specified by:

setFactorType in interface UserFactor

getId

public String getId()

Specified by:

getId in interface UserFactor

getLastUpdated

public Date getLastUpdated()

Specified by:

getLastUpdated in interface UserFactor

getProvider

public FactorProvider getProvider()

Specified by:

getProvider in interface UserFactor

setProvider

public UserFactor setProvider(FactorProvider provider)

Specified by:

setProvider in interface UserFactor

getStatus

public FactorStatus getStatus()

Specified by:

getStatus in interface UserFactor

getVerify

public VerifyFactorRequest getVerify()

Specified by:

getVerify in interface UserFactor

setVerify

public UserFactor setVerify(VerifyFactorRequest verify)

Specified by:

setVerify in interface UserFactor

delete

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2023-07-07T09:07:53.917-05:00",
           comments="DELETE - /api/v1/users/{userId}/factors/{factorId}")
public void delete()

Unenrolls an existing factor for the specified user, allowing the user to enroll a new factor.

Specified by:

delete in interface Deletable

Specified by:

delete in interface UserFactor

Overrides:

delete in class AbstractInstanceResource<UserFactor>

activate

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2023-07-07T09:07:53.917-05:00",
           comments="POST - /api/v1/users/{userId}/factors/{factorId}/lifecycle/activate")
public UserFactor activate(ActivateFactorRequest body)

Activate Factor The `sms` and `token:software:totp` factor types require activation to complete the enrollment process.

Specified by:

activate in interface UserFactor

Parameters:

body - (optional)

Returns:

UserFactor

activate

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2023-07-07T09:07:53.917-05:00",
           comments="POST - /api/v1/users/{userId}/factors/{factorId}/lifecycle/activate")
public UserFactor activate()

Activate Factor The `sms` and `token:software:totp` factor types require activation to complete the enrollment process.

Specified by:

activate in interface UserFactor

Returns:

UserFactor

verify

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2023-07-07T09:07:53.917-05:00",
           comments="POST - /api/v1/users/{userId}/factors/{factorId}/verify")
public VerifyUserFactorResponse verify(VerifyFactorRequest body,
                                                                                                                                                                                                                                              String templateId,
                                                                                                                                                                                                                                              Integer tokenLifetimeSeconds,
                                                                                                                                                                                                                                              String xForwardedFor,
                                                                                                                                                                                                                                              String userAgent,
                                                                                                                                                                                                                                              String acceptLanguage)

Verify MFA Factor Verifies an OTP for a `token` or `token:hardware` factor

Specified by:

verify in interface UserFactor

Parameters:

body - (optional)

templateId - (optional)

tokenLifetimeSeconds - (optional, default to 300)

xForwardedFor - (optional)

userAgent - (optional)

acceptLanguage - (optional)

Returns:

VerifyUserFactorResponse

verify

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2023-07-07T09:07:53.917-05:00",
           comments="POST - /api/v1/users/{userId}/factors/{factorId}/verify")
public VerifyUserFactorResponse verify()

Verify MFA Factor Verifies an OTP for a `token` or `token:hardware` factor

Specified by:

verify in interface UserFactor

Returns:

VerifyUserFactorResponse