MfaTotpDevice¶

class oci.identity.models.MfaTotpDevice(**kwargs)¶

Bases: object

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.

Attributes

`LIFECYCLE_STATE_ACTIVE`	A constant which can be used with the lifecycle_state property of a MfaTotpDevice.
`LIFECYCLE_STATE_CREATING`	A constant which can be used with the lifecycle_state property of a MfaTotpDevice.
`LIFECYCLE_STATE_DELETED`	A constant which can be used with the lifecycle_state property of a MfaTotpDevice.
`LIFECYCLE_STATE_DELETING`	A constant which can be used with the lifecycle_state property of a MfaTotpDevice.
`LIFECYCLE_STATE_INACTIVE`	A constant which can be used with the lifecycle_state property of a MfaTotpDevice.
`id`	[Required] Gets the id of this MfaTotpDevice.
`inactive_status`	Gets the inactive_status of this MfaTotpDevice.
`is_activated`	[Required] Gets the is_activated of this MfaTotpDevice.
`lifecycle_state`	[Required] Gets the lifecycle_state of this MfaTotpDevice.
`seed`	[Required] Gets the seed of this MfaTotpDevice.
`time_created`	[Required] Gets the time_created of this MfaTotpDevice.
`time_expires`	Gets the time_expires of this MfaTotpDevice.
`user_id`	[Required] Gets the user_id of this MfaTotpDevice.

Methods

__init__(**kwargs) Initializes a new MfaTotpDevice object with values from keyword arguments.

LIFECYCLE_STATE_ACTIVE = 'ACTIVE'¶: A constant which can be used with the lifecycle_state property of a MfaTotpDevice. This constant has a value of “ACTIVE”

LIFECYCLE_STATE_CREATING = 'CREATING'¶: A constant which can be used with the lifecycle_state property of a MfaTotpDevice. This constant has a value of “CREATING”

LIFECYCLE_STATE_DELETED = 'DELETED'¶: A constant which can be used with the lifecycle_state property of a MfaTotpDevice. This constant has a value of “DELETED”

LIFECYCLE_STATE_DELETING = 'DELETING'¶: A constant which can be used with the lifecycle_state property of a MfaTotpDevice. This constant has a value of “DELETING”

LIFECYCLE_STATE_INACTIVE = 'INACTIVE'¶: A constant which can be used with the lifecycle_state property of a MfaTotpDevice. This constant has a value of “INACTIVE”

__init__(**kwargs)¶

Initializes a new MfaTotpDevice object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters:

id (str) – The value to assign to the id property of this MfaTotpDevice.
seed (str) – The value to assign to the seed property of this MfaTotpDevice.
user_id (str) – The value to assign to the user_id property of this MfaTotpDevice.
time_created (datetime) – The value to assign to the time_created property of this MfaTotpDevice.
time_expires (datetime) – The value to assign to the time_expires property of this MfaTotpDevice.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this MfaTotpDevice. Allowed values for this property are: “CREATING”, “ACTIVE”, “INACTIVE”, “DELETING”, “DELETED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
inactive_status (int) – The value to assign to the inactive_status property of this MfaTotpDevice.
is_activated (bool) – The value to assign to the is_activated property of this MfaTotpDevice.

id¶

[Required] Gets the id of this MfaTotpDevice. The OCID of the MFA TOTP device.

Returns:	The id of this MfaTotpDevice.
Return type:	str

inactive_status¶

Gets the inactive_status of this MfaTotpDevice. The detailed status of INACTIVE lifecycleState. Allowed values are:

1 - SUSPENDED

2 - DISABLED

4 - BLOCKED

8 - LOCKED

Returns:	The inactive_status of this MfaTotpDevice.
Return type:	int

is_activated¶

[Required] Gets the is_activated of this MfaTotpDevice. Flag to indicate if the MFA TOTP device has been activated.

Returns:	The is_activated of this MfaTotpDevice.
Return type:	bool

lifecycle_state¶

[Required] Gets the lifecycle_state of this MfaTotpDevice. 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.

Allowed values for this property are: “CREATING”, “ACTIVE”, “INACTIVE”, “DELETING”, “DELETED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:	The lifecycle_state of this MfaTotpDevice.
Return type:	str

seed¶

[Required] Gets the seed of this MfaTotpDevice. The seed for the MFA TOTP device (Base32 encoded).

Returns:	The seed of this MfaTotpDevice.
Return type:	str

time_created¶

[Required] Gets the time_created of this MfaTotpDevice. Date and time the MfaTotpDevice object was created, in the format defined by RFC3339.

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

Returns:	The time_created of this MfaTotpDevice.
Return type:	datetime

time_expires¶

Gets the time_expires of this MfaTotpDevice. 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 time_expires of this MfaTotpDevice.
Return type:	datetime

user_id¶

[Required] Gets the user_id of this MfaTotpDevice. The OCID of the user the MFA TOTP device belongs to.

Returns:	The user_id of this MfaTotpDevice.
Return type:	str