Factor (Okta Java SDK :: API 1.5.1 API)

All Superinterfaces:

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

All Known Subinterfaces:

CallFactor, EmailFactor, HardwareFactor, PushFactor, SecurityQuestionFactor, SmsFactor, TokenFactor, TotpFactor, U2fFactor, WebFactor
```
@Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2019-03-25T12:49:41.184-04:00")
public interface Factor
extends ExtensibleResource, Deletable
```
Factor

Nested Class Summary
- Nested classes/interfaces inherited from interface java.util.Map
  Map.Entry<K,V>

Method Summary

All Methods Instance Methods Abstract Methods Deprecated Methods
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()`
`FactorProvider`	`getProvider()`
`Boolean`	`getRechallengeExistingFactor()`
`String`	`getSessionId()`
`FactorStatus`	`getStatus()`
`Integer`	`getTokenLifetimeSeconds()`
`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`	`setTokenLifetimeSeconds(Integer tokenLifetimeSeconds)`
`Factor`	`setUserId(String userId)`
`Factor`	`setVerify(VerifyFactorRequest verify)`
`VerifyFactorResponse`	`verify(String templateId, Integer tokenLifetimeSeconds, VerifyFactorRequest body)` Deprecated. use `verify(VerifyFactorRequest, String, Integer)`
`VerifyFactorResponse`	`verify(String templateId, VerifyFactorRequest body)` Deprecated. use `verify(VerifyFactorRequest, String)`
`VerifyFactorResponse`	`verify(VerifyFactorRequest body)` Verify MFA Factor Verifies an OTP for a `token` or `token:hardware` factor
`VerifyFactorResponse`	`verify(VerifyFactorRequest body, String templateId)` Verify MFA Factor Verifies an OTP for a `token` or `token:hardware` factor
`VerifyFactorResponse`	`verify(VerifyFactorRequest body, String templateId, Integer tokenLifetimeSeconds)` 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()
```

getDevice
```
String getDevice()
```

setDevice
```
Factor setDevice(String device)
```

getDeviceType
```
String getDeviceType()
```

getFactorType
```
FactorType getFactorType()
```

setFactorType

Factor setFactorType(FactorType factorType)

getId
```
String getId()
```

getMfaStateTokenId
```
String getMfaStateTokenId()
```

setMfaStateTokenId

Factor setMfaStateTokenId(String mfaStateTokenId)

getProfile
```
FactorProfile getProfile()
```

setProfile

Factor setProfile(FactorProfile profile)

getProvider
```
FactorProvider getProvider()
```

setProvider

Factor setProvider(FactorProvider provider)

getRechallengeExistingFactor
```
Boolean getRechallengeExistingFactor()
```

setRechallengeExistingFactor

Factor setRechallengeExistingFactor(Boolean rechallengeExistingFactor)

getSessionId
```
String getSessionId()
```

setSessionId
```
Factor setSessionId(String sessionId)
```

getStatus
```
FactorStatus getStatus()
```

getTokenLifetimeSeconds
```
Integer getTokenLifetimeSeconds()
```

setTokenLifetimeSeconds

Factor setTokenLifetimeSeconds(Integer tokenLifetimeSeconds)

getUserId
```
String getUserId()
```

setUserId
```
Factor setUserId(String userId)
```

getVerify
```
VerifyFactorRequest getVerify()
```

setVerify

Factor setVerify(VerifyFactorRequest verify)

delete

@Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2019-03-25T12:49:41.184-04: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="2019-03-25T12:49:41.184-04:00",
           comments="POST - /api/v1/users/{userId}/factors/{factorId}/lifecycle/activate")
Factor activate(VerifyFactorRequest body)

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

Parameters:: body - (required)
Returns:: Factor