Class MfaTotpDevice

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.

Inheritance
System.Object
MfaTotpDevice
Namespace: Oci.IdentityService.Models
Assembly: OCI.DotNetSDK.Identity.dll
Syntax
public class MfaTotpDevice : object

Properties

Id

Declaration
public string Id { get; set; }
Property Value
Type Description
System.String

The OCID of the MFA TOTP device.
Remarks

Required

InactiveStatus

Declaration
public System.Nullable<long> InactiveStatus { get; set; }
Property Value
Type Description
System.Nullable<System.Int64>

The detailed status of INACTIVE lifecycleState. Allowed values are:

  • 1 - SUSPENDED
  • 2 - DISABLED
  • 4 - BLOCKED
  • 8 - LOCKED

IsActivated

Declaration
public System.Nullable<bool> IsActivated { get; set; }
Property Value
Type Description
System.Nullable<System.Boolean>

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

Required

LifecycleState

Declaration
public System.Nullable<MfaTotpDevice.LifecycleStateEnum> LifecycleState { get; set; }
Property Value
Type Description
System.Nullable<MfaTotpDevice.LifecycleStateEnum>

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.
Remarks

Required

Seed

Declaration
public string Seed { get; set; }
Property Value
Type Description
System.String

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

Required

TimeCreated

Declaration
public System.Nullable<System.DateTime> TimeCreated { get; set; }
Property Value
Type Description
System.Nullable<System.DateTime>

Date and time the MfaTotpDevice object was created, in the format defined by RFC3339.
Example: 2016-08-25T21:10:29.600Z
Remarks

Required

TimeExpires

Declaration
public System.Nullable<System.DateTime> TimeExpires { get; set; }
Property Value
Type Description
System.Nullable<System.DateTime>

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

UserId

Declaration
public string UserId { get; set; }
Property Value
Type Description
System.String

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

Required