ExtensionMfaUser

class oci.identity_domains.models.ExtensionMfaUser(**kwargs)

Bases: object

This extension defines attributes used to manage Multi-Factor Authentication within a service provider. The extension is typically applied to a User resource, but MAY be applied to other resources that use MFA.

Attributes:

MFA_STATUS_DISABLED

A constant which can be used with the mfa_status property of a ExtensionMfaUser.

MFA_STATUS_ENROLLED

A constant which can be used with the mfa_status property of a ExtensionMfaUser.

MFA_STATUS_IGNORED

A constant which can be used with the mfa_status property of a ExtensionMfaUser.

MFA_STATUS_UN_ENROLLED

A constant which can be used with the mfa_status property of a ExtensionMfaUser.

PREFERRED_AUTHENTICATION_FACTOR_EMAIL

A constant which can be used with the preferred_authentication_factor property of a ExtensionMfaUser.

PREFERRED_AUTHENTICATION_FACTOR_FIDO_AUTHENTICATOR

A constant which can be used with the preferred_authentication_factor property of a ExtensionMfaUser.

PREFERRED_AUTHENTICATION_FACTOR_OFFLINETOTP

A constant which can be used with the preferred_authentication_factor property of a ExtensionMfaUser.

PREFERRED_AUTHENTICATION_FACTOR_PHONE_CALL

A constant which can be used with the preferred_authentication_factor property of a ExtensionMfaUser.

PREFERRED_AUTHENTICATION_FACTOR_PUSH

A constant which can be used with the preferred_authentication_factor property of a ExtensionMfaUser.

PREFERRED_AUTHENTICATION_FACTOR_SECURITY_QUESTIONS

A constant which can be used with the preferred_authentication_factor property of a ExtensionMfaUser.

PREFERRED_AUTHENTICATION_FACTOR_SMS

A constant which can be used with the preferred_authentication_factor property of a ExtensionMfaUser.

PREFERRED_AUTHENTICATION_FACTOR_THIRDPARTY

A constant which can be used with the preferred_authentication_factor property of a ExtensionMfaUser.

PREFERRED_AUTHENTICATION_FACTOR_TOTP

A constant which can be used with the preferred_authentication_factor property of a ExtensionMfaUser.

PREFERRED_AUTHENTICATION_FACTOR_USERNAME_PASSWORD

A constant which can be used with the preferred_authentication_factor property of a ExtensionMfaUser.

PREFERRED_AUTHENTICATION_FACTOR_VOICE

A constant which can be used with the preferred_authentication_factor property of a ExtensionMfaUser.

PREFERRED_AUTHENTICATION_FACTOR_YUBICO_OTP

A constant which can be used with the preferred_authentication_factor property of a ExtensionMfaUser.

bypass_codes

Gets the bypass_codes of this ExtensionMfaUser.

devices

Gets the devices of this ExtensionMfaUser.

login_attempts

Gets the login_attempts of this ExtensionMfaUser.

mfa_enabled_on

Gets the mfa_enabled_on of this ExtensionMfaUser.

mfa_ignored_apps

Gets the mfa_ignored_apps of this ExtensionMfaUser.

mfa_status

Gets the mfa_status of this ExtensionMfaUser.

preferred_authentication_factor

Gets the preferred_authentication_factor of this ExtensionMfaUser.

preferred_authentication_method

Gets the preferred_authentication_method of this ExtensionMfaUser.

preferred_device

Gets the preferred_device of this ExtensionMfaUser.

preferred_third_party_vendor

Gets the preferred_third_party_vendor of this ExtensionMfaUser.

trusted_user_agents

Gets the trusted_user_agents of this ExtensionMfaUser.

Methods:

__init__(**kwargs)

Initializes a new ExtensionMfaUser object with values from keyword arguments.

MFA_STATUS_DISABLED = 'DISABLED'

A constant which can be used with the mfa_status property of a ExtensionMfaUser. This constant has a value of “DISABLED”

MFA_STATUS_ENROLLED = 'ENROLLED'

A constant which can be used with the mfa_status property of a ExtensionMfaUser. This constant has a value of “ENROLLED”

MFA_STATUS_IGNORED = 'IGNORED'

A constant which can be used with the mfa_status property of a ExtensionMfaUser. This constant has a value of “IGNORED”

MFA_STATUS_UN_ENROLLED = 'UN_ENROLLED'

A constant which can be used with the mfa_status property of a ExtensionMfaUser. This constant has a value of “UN_ENROLLED”

PREFERRED_AUTHENTICATION_FACTOR_EMAIL = 'EMAIL'

A constant which can be used with the preferred_authentication_factor property of a ExtensionMfaUser. This constant has a value of “EMAIL”

PREFERRED_AUTHENTICATION_FACTOR_FIDO_AUTHENTICATOR = 'FIDO_AUTHENTICATOR'

A constant which can be used with the preferred_authentication_factor property of a ExtensionMfaUser. This constant has a value of “FIDO_AUTHENTICATOR”

PREFERRED_AUTHENTICATION_FACTOR_OFFLINETOTP = 'OFFLINETOTP'

A constant which can be used with the preferred_authentication_factor property of a ExtensionMfaUser. This constant has a value of “OFFLINETOTP”

PREFERRED_AUTHENTICATION_FACTOR_PHONE_CALL = 'PHONE_CALL'

A constant which can be used with the preferred_authentication_factor property of a ExtensionMfaUser. This constant has a value of “PHONE_CALL”

PREFERRED_AUTHENTICATION_FACTOR_PUSH = 'PUSH'

A constant which can be used with the preferred_authentication_factor property of a ExtensionMfaUser. This constant has a value of “PUSH”

PREFERRED_AUTHENTICATION_FACTOR_SECURITY_QUESTIONS = 'SECURITY_QUESTIONS'

A constant which can be used with the preferred_authentication_factor property of a ExtensionMfaUser. This constant has a value of “SECURITY_QUESTIONS”

PREFERRED_AUTHENTICATION_FACTOR_SMS = 'SMS'

A constant which can be used with the preferred_authentication_factor property of a ExtensionMfaUser. This constant has a value of “SMS”

PREFERRED_AUTHENTICATION_FACTOR_THIRDPARTY = 'THIRDPARTY'

A constant which can be used with the preferred_authentication_factor property of a ExtensionMfaUser. This constant has a value of “THIRDPARTY”

PREFERRED_AUTHENTICATION_FACTOR_TOTP = 'TOTP'

A constant which can be used with the preferred_authentication_factor property of a ExtensionMfaUser. This constant has a value of “TOTP”

PREFERRED_AUTHENTICATION_FACTOR_USERNAME_PASSWORD = 'USERNAME_PASSWORD'

A constant which can be used with the preferred_authentication_factor property of a ExtensionMfaUser. This constant has a value of “USERNAME_PASSWORD”

PREFERRED_AUTHENTICATION_FACTOR_VOICE = 'VOICE'

A constant which can be used with the preferred_authentication_factor property of a ExtensionMfaUser. This constant has a value of “VOICE”

PREFERRED_AUTHENTICATION_FACTOR_YUBICO_OTP = 'YUBICO_OTP'

A constant which can be used with the preferred_authentication_factor property of a ExtensionMfaUser. This constant has a value of “YUBICO_OTP”

__init__(**kwargs)

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

Parameters
  • preferred_authentication_factor (str) – The value to assign to the preferred_authentication_factor property of this ExtensionMfaUser. Allowed values for this property are: “EMAIL”, “SMS”, “TOTP”, “PUSH”, “OFFLINETOTP”, “USERNAME_PASSWORD”, “SECURITY_QUESTIONS”, “VOICE”, “PHONE_CALL”, “THIRDPARTY”, “FIDO_AUTHENTICATOR”, “YUBICO_OTP”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

  • mfa_status (str) – The value to assign to the mfa_status property of this ExtensionMfaUser. Allowed values for this property are: “ENROLLED”, “IGNORED”, “UN_ENROLLED”, “DISABLED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

  • preferred_third_party_vendor (str) – The value to assign to the preferred_third_party_vendor property of this ExtensionMfaUser.

  • preferred_authentication_method (str) – The value to assign to the preferred_authentication_method property of this ExtensionMfaUser.

  • login_attempts (int) – The value to assign to the login_attempts property of this ExtensionMfaUser.

  • mfa_enabled_on (str) – The value to assign to the mfa_enabled_on property of this ExtensionMfaUser.

  • mfa_ignored_apps (list[str]) – The value to assign to the mfa_ignored_apps property of this ExtensionMfaUser.

  • preferred_device (oci.identity_domains.models.UserExtPreferredDevice) – The value to assign to the preferred_device property of this ExtensionMfaUser.

  • devices (list[oci.identity_domains.models.UserExtDevices]) – The value to assign to the devices property of this ExtensionMfaUser.

  • bypass_codes (list[oci.identity_domains.models.UserExtBypassCodes]) – The value to assign to the bypass_codes property of this ExtensionMfaUser.

  • trusted_user_agents (list[oci.identity_domains.models.UserExtTrustedUserAgents]) – The value to assign to the trusted_user_agents property of this ExtensionMfaUser.

property bypass_codes

Gets the bypass_codes of this ExtensionMfaUser. A list of bypass codes that belongs to the user.

Added In: 18.3.6

SCIM++ Properties:
  • idcsCompositeKey: [value]

  • multiValued: true

  • mutability: readOnly

  • required: false

  • returned: request

  • type: complex

  • uniqueness: none

Returns

The bypass_codes of this ExtensionMfaUser.

Return type

list[oci.identity_domains.models.UserExtBypassCodes]

property devices

Gets the devices of this ExtensionMfaUser. A list of devices enrolled by the user.

Added In: 18.3.6

SCIM++ Properties:
  • idcsCompositeKey: [value]

  • multiValued: true

  • mutability: readOnly

  • required: false

  • returned: request

  • type: complex

  • uniqueness: none

Returns

The devices of this ExtensionMfaUser.

Return type

list[oci.identity_domains.models.UserExtDevices]

property login_attempts

Gets the login_attempts of this ExtensionMfaUser. The number of incorrect multi factor authentication sign in attempts made by this user. The user is locked if this reaches the threshold specified in the maxIncorrectAttempts attribute in AuthenticationFactorSettings.

Added In: 18.3.6

SCIM++ Properties:
  • idcsSearchable: false

  • multiValued: false

  • mutability: readOnly

  • idcsRequiresWriteForAccessFlows: true

  • idcsRequiresImmediateReadAfterWriteForAccessFlows: true

  • required: false

  • returned: default

  • type: integer

  • uniqueness: none

Returns

The login_attempts of this ExtensionMfaUser.

Return type

int

property mfa_enabled_on

Gets the mfa_enabled_on of this ExtensionMfaUser. The date when the user enrolled in multi factor authentication. This will be set to null, when the user resets their factors.

Added In: 18.3.6

SCIM++ Properties:
  • idcsSearchable: false

  • multiValued: false

  • mutability: readWrite

  • required: false

  • returned: request

  • type: dateTime

  • uniqueness: none

Returns

The mfa_enabled_on of this ExtensionMfaUser.

Return type

str

property mfa_ignored_apps

Gets the mfa_ignored_apps of this ExtensionMfaUser. User MFA Ignored Apps Identifiers

Added In: 19.2.1

SCIM++ Properties:
  • caseExact: true

  • idcsSearchable: true

  • multiValued: true

  • mutability: readWrite

  • required: false

  • returned: default

  • type: string

  • uniqueness: none

Returns

The mfa_ignored_apps of this ExtensionMfaUser.

Return type

list[str]

property mfa_status

Gets the mfa_status of this ExtensionMfaUser. The user opted for MFA.

Added In: 18.3.6

SCIM++ Properties:
  • caseExact: true

  • idcsSearchable: true

  • multiValued: false

  • mutability: readOnly

  • idcsRequiresWriteForAccessFlows: true

  • required: false

  • returned: default

  • type: string

  • uniqueness: none

Allowed values for this property are: “ENROLLED”, “IGNORED”, “UN_ENROLLED”, “DISABLED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns

The mfa_status of this ExtensionMfaUser.

Return type

str

property preferred_authentication_factor

Gets the preferred_authentication_factor of this ExtensionMfaUser. The preferred authentication factor type.

Added In: 18.3.6

SCIM++ Properties:
  • caseExact: true

  • idcsSearchable: true

  • multiValued: false

  • mutability: readWrite

  • required: false

  • returned: default

  • type: string

  • uniqueness: none

Allowed values for this property are: “EMAIL”, “SMS”, “TOTP”, “PUSH”, “OFFLINETOTP”, “USERNAME_PASSWORD”, “SECURITY_QUESTIONS”, “VOICE”, “PHONE_CALL”, “THIRDPARTY”, “FIDO_AUTHENTICATOR”, “YUBICO_OTP”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns

The preferred_authentication_factor of this ExtensionMfaUser.

Return type

str

property preferred_authentication_method

Gets the preferred_authentication_method of this ExtensionMfaUser. The preferred authentication method.

Added In: 2009232244

SCIM++ Properties:
  • caseExact: true

  • idcsSearchable: false

  • multiValued: false

  • mutability: readWrite

  • required: false

  • returned: default

  • type: string

  • uniqueness: none

Returns

The preferred_authentication_method of this ExtensionMfaUser.

Return type

str

property preferred_device

Gets the preferred_device of this ExtensionMfaUser.

Returns

The preferred_device of this ExtensionMfaUser.

Return type

oci.identity_domains.models.UserExtPreferredDevice

property preferred_third_party_vendor

Gets the preferred_third_party_vendor of this ExtensionMfaUser. The preferred third-party vendor name.

Added In: 19.2.1

SCIM++ Properties:
  • caseExact: true

  • idcsSearchable: true

  • multiValued: false

  • mutability: readWrite

  • required: false

  • returned: default

  • type: string

  • uniqueness: none

Returns

The preferred_third_party_vendor of this ExtensionMfaUser.

Return type

str

property trusted_user_agents

Gets the trusted_user_agents of this ExtensionMfaUser. A list of trusted User Agents owned by this user. Multi-Factored Authentication uses Trusted User Agents to authenticate users. A User Agent is software application that a user uses to issue requests. For example, a User Agent could be a particular browser (possibly one of several executing on a desktop or laptop) or a particular mobile application (again, oneof several executing on a particular mobile device). A User Agent is trusted once the Multi-Factor Authentication has verified it in some way.

Added In: 18.3.6

SCIM++ Properties:
  • idcsCompositeKey: [value]

  • multiValued: true

  • mutability: readWrite

  • required: false

  • returned: request

  • type: complex

  • uniqueness: none

Returns

The trusted_user_agents of this ExtensionMfaUser.

Return type

list[oci.identity_domains.models.UserExtTrustedUserAgents]