Package com.oracle.bmc.identity.model

Class MfaTotpDevice

java.lang.Object

com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

com.oracle.bmc.identity.model.MfaTotpDevice

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20160918")
public final class MfaTotpDevice
extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

Users can enable multi-factor authentication (MFA) for their own user accounts.

After MFA is enabled, the user is prompted for a time-based one-time password (TOTP) to authenticate before they can sign in to the Console. To enable multi-factor authentication, the user must register a mobile device with a TOTP authenticator app installed. The registration process creates the MfaTotpDevice object. The registration process requires interaction with the Console and cannot be completed programmatically. For more information, see Managing Multi-Factor Authentication.
Note: Objects should always be created or deserialized using the MfaTotpDevice.Builder. This model distinguishes fields that are null because they are unset from fields that are explicitly set to null. This is done in the setter methods of the MfaTotpDevice.Builder, which maintain a set of all explicitly set fields called MfaTotpDevice.Builder.__explicitlySet__. The hashCode() and equals(Object) methods are implemented to take the explicitly set fields into account. The constructor, on the other hand, does not take the explicitly set fields into account (since the constructor cannot distinguish explicit null from unset null).

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	MfaTotpDevice.Builder
static class	MfaTotpDevice.LifecycleState	The MFA TOTP device’s current state.

Field Summary

Fields inherited from class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

EXPLICITLY_SET_FILTER_NAME, EXPLICITLY_SET_PROPERTY_NAME

Constructor Summary

Constructors

Constructor	Description
MfaTotpDevice(String id, String seed, String userId, Date timeCreated, Date timeExpires, MfaTotpDevice.LifecycleState lifecycleState, Long inactiveStatus, Boolean isActivated)	Deprecated.

Method Summary

Modifier and Type	Method	Description
static MfaTotpDevice.Builder	builder()	Create a new builder.
boolean	equals(Object o)
String	getId()	The OCID of the MFA TOTP device.
Long	getInactiveStatus()	The detailed status of INACTIVE lifecycleState.
Boolean	getIsActivated()	Flag to indicate if the MFA TOTP device has been activated.
MfaTotpDevice.LifecycleState	getLifecycleState()	The MFA TOTP device’s current state.
String	getSeed()	The seed for the MFA TOTP device (Base32 encoded).
Date	getTimeCreated()	Date and time the MfaTotpDevice object was created, in the format defined by RFC3339.
Date	getTimeExpires()	Date and time when this MFA TOTP device will expire, in the format defined by RFC3339.
String	getUserId()	The OCID of the user the MFA TOTP device belongs to.
int	hashCode()
MfaTotpDevice.Builder	toBuilder()
String	toString()
String	toString(boolean includeByteArrayContents)	Return a string representation of the object.

Methods inherited from class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

markPropertyAsExplicitlySet, wasPropertyExplicitlySet

Methods inherited from class java.lang.Object

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

Constructor Detail

MfaTotpDevice

@Deprecated
@ConstructorProperties({"id","seed","userId","timeCreated","timeExpires","lifecycleState","inactiveStatus","isActivated"})
public MfaTotpDevice(String id,
                     String seed,
                     String userId,
                     Date timeCreated,
                     Date timeExpires,
                     MfaTotpDevice.LifecycleState lifecycleState,
                     Long inactiveStatus,
                     Boolean isActivated)

Deprecated.

Method Detail

builder

public static MfaTotpDevice.Builder builder()

Create a new builder.

toBuilder

public MfaTotpDevice.Builder toBuilder()

getId

public String getId()

The OCID of the MFA TOTP device.

Returns:

the value

getSeed

public String getSeed()

The seed for the MFA TOTP device (Base32 encoded).

Returns:

the value

getUserId

public String getUserId()

The OCID of the user the MFA TOTP device belongs to.

Returns:

the value

getTimeCreated

public Date getTimeCreated()

Date and time the MfaTotpDevice object was created, in the format defined by RFC3339.

Example: 2016-08-25T21:10:29.600Z

Returns:

the value

getTimeExpires

public Date getTimeExpires()

Date and time when this MFA TOTP device will expire, in the format defined by RFC3339.

Null if it never expires.

Example: 2016-08-25T21:10:29.600Z

Returns:

the value

getLifecycleState

public MfaTotpDevice.LifecycleState getLifecycleState()

The MFA TOTP device’s current state.

After creating the MFA TOTP device, make sure its lifecycleState changes from CREATING to ACTIVE before using it.

Returns:

the value

getInactiveStatus

public Long getInactiveStatus()

The detailed status of INACTIVE lifecycleState.

Allowed values are: - 1 - SUSPENDED - 2 - DISABLED - 4 - BLOCKED - 8 - LOCKED

Returns:

the value

getIsActivated

public Boolean getIsActivated()

Flag to indicate if the MFA TOTP device has been activated.

Returns:

the value

toString

public String toString()

Overrides:

toString in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

toString

public String toString(boolean includeByteArrayContents)

Return a string representation of the object.

Parameters:

includeByteArrayContents - true to include the full contents of byte arrays

Returns:

string representation

equals

public boolean equals(Object o)

Overrides:

equals in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

hashCode

public int hashCode()

Overrides:

hashCode in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel