Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace 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 {@code MfaTotpDevice} object. The registration process requires interaction with the Console and cannot be completed programmatically. For more information, see Managing Multi-Factor Authentication.

Properties

id

id: string

The OCID of the MFA TOTP device.

Optional inactiveStatus

inactiveStatus: undefined | number

The detailed status of INACTIVE lifecycleState. Allowed values are:

  • 1 - SUSPENDED
  • 2 - DISABLED
  • 4 - BLOCKED
  • 8 - LOCKED Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

isActivated

isActivated: boolean

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

lifecycleState

lifecycleState: LifecycleState

The MFA TOTP device's current state. After creating the MFA TOTP device, make sure its {@code lifecycleState} changes from CREATING to ACTIVE before using it.

seed

seed: string

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

timeCreated

timeCreated: Date

Date and time the {@code MfaTotpDevice} object was created, in the format defined by RFC3339.

Example: {@code 2016-08-25T21:10:29.600Z}

Optional timeExpires

timeExpires: Date

Date and time when this MFA TOTP device will expire, in the format defined by RFC3339. Null if it never expires.

Example: {@code 2016-08-25T21:10:29.600Z}

userId

userId: string

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

Functions

getDeserializedJsonObj

getJsonObj