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

Class DefaultFactor

java.lang.Object

com.okta.sdk.impl.resource.AbstractPropertyRetriever

com.okta.sdk.impl.resource.AbstractResource

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

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

All Implemented Interfaces:

Deletable, PropertyRetriever, Resource, Saveable<Factor>, Factor

Direct Known Subclasses:

DefaultCallFactor, DefaultEmailFactor, DefaultHardwareFactor, DefaultPushFactor, DefaultSecurityQuestionFactor, DefaultSmsFactor, DefaultTokenFactor, DefaultTotpFactor, DefaultWebFactor

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2017-12-14T13:01:44.308-05:00")
public class DefaultFactor
extends AbstractInstanceResource<Factor>
implements Factor

Factor

Field Summary

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

deletedPropertyNames, dirty, dirtyProperties, properties, referenceFactory

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

readLock, writeLock

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
Factor	activate(VerifyFactorRequest body) Activate Factor The `sms` and `token:software:totp` [factor types](#factor-type) 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.
String	getDevice()
String	getDeviceType()
Map<String,Object>	getEmbedded()
FactorType	getFactorType()
String	getId()
Map<String,Object>	getLinks()
String	getMfaStateTokenId()
FactorProfile	getProfile()
Map<String,Property>	getPropertyDescriptors()
FactorProvider	getProvider()
Boolean	getRechallengeExistingFactor()
String	getSessionId()
FactorStatus	getStatus()
String	getUserId()
VerifyFactorRequest	getVerify()
Factor	setDevice(String device)
Factor	setFactorType(FactorType factorType)
Factor	setMfaStateTokenId(String mfaStateTokenId)
Factor	setProfile(FactorProfile profile)
Factor	setProvider(FactorProvider provider)
Factor	setRechallengeExistingFactor(Boolean rechallengeExistingFactor)
Factor	setSessionId(String sessionId)
Factor	setUserId(String userId)
Factor	setVerify(VerifyFactorRequest verify)
VerifyFactorResponse	verify(String templateId, VerifyFactorRequest body) Verify MFA Factor Verifies an OTP for a `token` or `token:hardware` factor
VerifyFactorResponse	verify(VerifyFactorRequest body) Verify MFA Factor Verifies an OTP for a `token` or `token:hardware` factor

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

isInstanceResource, save

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

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

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

getBoolean, getBoolean, getBooleanProperty, getDateProperty, getDoubleProperty, getDoubleProperty, getEnumListProperty, getEnumProperty, getEnumProperty, getInt, getInteger, getIntegerList, getIntProperty, getIntProperty, getListProperty, getListProperty, getMap, getMapProperty, 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

Constructor Detail

DefaultFactor

public DefaultFactor(InternalDataStore dataStore)

DefaultFactor

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

Method Detail

getPropertyDescriptors

public Map<String,Property> getPropertyDescriptors()

Specified by:

getPropertyDescriptors in class AbstractResource

getEmbedded

public Map<String,Object> getEmbedded()

Specified by:

getEmbedded in interface Factor

getLinks

public Map<String,Object> getLinks()

Specified by:

getLinks in interface Factor

getDevice

public String getDevice()

Specified by:

getDevice in interface Factor

setDevice

public Factor setDevice(String device)

Specified by:

setDevice in interface Factor

getDeviceType

public String getDeviceType()

Specified by:

getDeviceType in interface Factor

getFactorType

public FactorType getFactorType()

Specified by:

getFactorType in interface Factor

setFactorType

public Factor setFactorType(FactorType factorType)

Specified by:

setFactorType in interface Factor

getId

public String getId()

Specified by:

getId in interface Factor

getMfaStateTokenId

public String getMfaStateTokenId()

Specified by:

getMfaStateTokenId in interface Factor

setMfaStateTokenId

public Factor setMfaStateTokenId(String mfaStateTokenId)

Specified by:

setMfaStateTokenId in interface Factor

getProfile

public FactorProfile getProfile()

Specified by:

getProfile in interface Factor

setProfile

public Factor setProfile(FactorProfile profile)

Specified by:

setProfile in interface Factor

getProvider

public FactorProvider getProvider()

Specified by:

getProvider in interface Factor

setProvider

public Factor setProvider(FactorProvider provider)

Specified by:

setProvider in interface Factor

getRechallengeExistingFactor

public Boolean getRechallengeExistingFactor()

Specified by:

getRechallengeExistingFactor in interface Factor

setRechallengeExistingFactor

public Factor setRechallengeExistingFactor(Boolean rechallengeExistingFactor)

Specified by:

setRechallengeExistingFactor in interface Factor

getSessionId

public String getSessionId()

Specified by:

getSessionId in interface Factor

setSessionId

public Factor setSessionId(String sessionId)

Specified by:

setSessionId in interface Factor

getStatus

public FactorStatus getStatus()

Specified by:

getStatus in interface Factor

getUserId

public String getUserId()

Specified by:

getUserId in interface Factor

setUserId

public Factor setUserId(String userId)

Specified by:

setUserId in interface Factor

getVerify

public VerifyFactorRequest getVerify()

Specified by:

getVerify in interface Factor

setVerify

public Factor setVerify(VerifyFactorRequest verify)

Specified by:

setVerify in interface Factor

delete

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2017-12-14T13:01:44.308-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 Factor

Overrides:

delete in class AbstractInstanceResource<Factor>

activate

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2017-12-14T13:01:44.308-05:00",
           comments="POST - /api/v1/users/{userId}/factors/{factorId}/lifecycle/activate")
public Factor activate(VerifyFactorRequest body)

Activate Factor The `sms` and `token:software:totp` [factor types](#factor-type) require activation to complete the enrollment process.

Specified by:

activate in interface Factor

Parameters:

body - (required)

Returns:

Factor

verify

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2017-12-14T13:01:44.308-05:00",
           comments="POST - /api/v1/users/{userId}/factors/{factorId}/verify")
public VerifyFactorResponse verify(String templateId,
                                                                                                                                                                                                                                          VerifyFactorRequest body)

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

Specified by:

verify in interface Factor

Parameters:

templateId - (optional)

body - (required)

Returns:

VerifyFactorResponse

verify

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2017-12-14T13:01:44.308-05:00",
           comments="POST - /api/v1/users/{userId}/factors/{factorId}/verify")
public VerifyFactorResponse verify(VerifyFactorRequest body)

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

Specified by:

verify in interface Factor

Parameters:

body - (required)

Returns:

VerifyFactorResponse