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.
Inherited Members
Namespace: Oci.IdentityService.Models
Assembly: OCI.DotNetSDK.Identity.dll
Syntax
public class MfaTotpDevice
Properties
Id
Declaration
[Required(ErrorMessage = "Id is required.")]
[JsonProperty(PropertyName = "id")]
public string Id { get; set; }
Property Value
Type | Description |
---|---|
string | The OCID of the MFA TOTP device. |
Remarks
Required
InactiveStatus
Declaration
[JsonProperty(PropertyName = "inactiveStatus")]
public long? InactiveStatus { get; set; }
Property Value
Type | Description |
---|---|
long? | The detailed status of INACTIVE lifecycleState. Allowed values are:
|
IsActivated
Declaration
[Required(ErrorMessage = "IsActivated is required.")]
[JsonProperty(PropertyName = "isActivated")]
public bool? IsActivated { get; set; }
Property Value
Type | Description |
---|---|
bool? | Flag to indicate if the MFA TOTP device has been activated. |
Remarks
Required
LifecycleState
Declaration
[Required(ErrorMessage = "LifecycleState is required.")]
[JsonProperty(PropertyName = "lifecycleState")]
[JsonConverter(typeof(ResponseEnumConverter))]
public MfaTotpDevice.LifecycleStateEnum? LifecycleState { get; set; }
Property Value
Type | Description |
---|---|
MfaTotpDevice.LifecycleStateEnum? | The MFA TOTP device's current state. After creating the MFA TOTP device, make sure its |
Remarks
Required
Seed
Declaration
[Required(ErrorMessage = "Seed is required.")]
[JsonProperty(PropertyName = "seed")]
public string Seed { get; set; }
Property Value
Type | Description |
---|---|
string | The seed for the MFA TOTP device (Base32 encoded). |
Remarks
Required
TimeCreated
Declaration
[Required(ErrorMessage = "TimeCreated is required.")]
[JsonProperty(PropertyName = "timeCreated")]
public DateTime? TimeCreated { get; set; }
Property Value
Type | Description |
---|---|
DateTime? | Date and time the |
Remarks
Required
TimeExpires
Declaration
[JsonProperty(PropertyName = "timeExpires")]
public DateTime? TimeExpires { get; set; }
Property Value
Type | Description |
---|---|
DateTime? | Date and time when this MFA TOTP device will expire, in the format defined by RFC3339.
Null if it never expires.
|
UserId
Declaration
[Required(ErrorMessage = "UserId is required.")]
[JsonProperty(PropertyName = "userId")]
public string UserId { get; set; }
Property Value
Type | Description |
---|---|
string | The OCID of the user the MFA TOTP device belongs to. |
Remarks
Required