com.okta.sdk.resource.user.factor

Interface UserFactor

All Superinterfaces:

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

All Known Subinterfaces:

CallUserFactor, CustomHotpUserFactor, EmailUserFactor, HardwareUserFactor, PushUserFactor, SecurityQuestionUserFactor, SmsUserFactor, TokenUserFactor, TotpUserFactor, U2fUserFactor, WebAuthnUserFactor, WebUserFactor

All Known Implementing Classes:

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

@Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2023-07-07T09:07:50.516-05:00")
public interface UserFactor
extends ExtensibleResource, Deletable

UserFactor

Nested Class Summary

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

Map.Entry<K,V>

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()
FactorProvider	getProvider()
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 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

getEmbedded

Map<String,Object> getEmbedded()

getLinks

Map<String,Object> getLinks()

getCreated

Date getCreated()

getFactorType

FactorType getFactorType()

setFactorType

UserFactor setFactorType(FactorType factorType)

getId

String getId()

getLastUpdated

Date getLastUpdated()

getProvider

FactorProvider getProvider()

setProvider

UserFactor setProvider(FactorProvider provider)

getStatus

FactorStatus getStatus()

getVerify

VerifyFactorRequest getVerify()

setVerify

UserFactor setVerify(VerifyFactorRequest verify)

delete

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

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

Specified by:

delete in interface Deletable

activate

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

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

Parameters:

body - (optional)

Returns:

UserFactor

activate

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

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

Returns:

UserFactor

verify

@Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2023-07-07T09:07:50.516-05:00",
           comments="POST - /api/v1/users/{userId}/factors/{factorId}/verify")
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

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.OktaJavaClientApiCodegen",
           date="2023-07-07T09:07:50.516-05:00",
           comments="POST - /api/v1/users/{userId}/factors/{factorId}/verify")
VerifyUserFactorResponse verify()

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

Returns:

VerifyUserFactorResponse