MyAuthenticationFactorInitiator¶

class oci.identity_domains.models.MyAuthenticationFactorInitiator(**kwargs)¶

Bases: object

This schema defines the attributes of Initiator call.

Attributes

`AUTH_FACTOR_EMAIL`	A constant which can be used with the auth_factor property of a MyAuthenticationFactorInitiator.
`AUTH_FACTOR_FIDO_AUTHENTICATOR`	A constant which can be used with the auth_factor property of a MyAuthenticationFactorInitiator.
`AUTH_FACTOR_PHONE_CALL`	A constant which can be used with the auth_factor property of a MyAuthenticationFactorInitiator.
`AUTH_FACTOR_PUSH`	A constant which can be used with the auth_factor property of a MyAuthenticationFactorInitiator.
`AUTH_FACTOR_SMS`	A constant which can be used with the auth_factor property of a MyAuthenticationFactorInitiator.
`AUTH_FACTOR_THIRDPARTY`	A constant which can be used with the auth_factor property of a MyAuthenticationFactorInitiator.
`AUTH_FACTOR_TOTP`	A constant which can be used with the auth_factor property of a MyAuthenticationFactorInitiator.
`AUTH_FACTOR_VOICE`	A constant which can be used with the auth_factor property of a MyAuthenticationFactorInitiator.
`AUTH_FACTOR_YUBICO_OTP`	A constant which can be used with the auth_factor property of a MyAuthenticationFactorInitiator.
`IDCS_PREVENTED_OPERATIONS_DELETE`	A constant which can be used with the idcs_prevented_operations property of a MyAuthenticationFactorInitiator.
`IDCS_PREVENTED_OPERATIONS_REPLACE`	A constant which can be used with the idcs_prevented_operations property of a MyAuthenticationFactorInitiator.
`IDCS_PREVENTED_OPERATIONS_UPDATE`	A constant which can be used with the idcs_prevented_operations property of a MyAuthenticationFactorInitiator.
`PREFERENCE_TYPE_MFA`	A constant which can be used with the preference_type property of a MyAuthenticationFactorInitiator.
`PREFERENCE_TYPE_PASSWORDLESS`	A constant which can be used with the preference_type property of a MyAuthenticationFactorInitiator.
`SCENARIO_AUTHENTICATION`	A constant which can be used with the scenario property of a MyAuthenticationFactorInitiator.
`SCENARIO_ENROLLMENT`	A constant which can be used with the scenario property of a MyAuthenticationFactorInitiator.
`TYPE_OIDC`	A constant which can be used with the type property of a MyAuthenticationFactorInitiator.
`TYPE_SAML`	A constant which can be used with the type property of a MyAuthenticationFactorInitiator.
`additional_attributes`	Gets the additional_attributes of this MyAuthenticationFactorInitiator.
`auth_factor`	[Required] Gets the auth_factor of this MyAuthenticationFactorInitiator.
`compartment_ocid`	Gets the compartment_ocid of this MyAuthenticationFactorInitiator.
`delete_in_progress`	Gets the delete_in_progress of this MyAuthenticationFactorInitiator.
`device_id`	[Required] Gets the device_id of this MyAuthenticationFactorInitiator.
`domain_ocid`	Gets the domain_ocid of this MyAuthenticationFactorInitiator.
`id`	Gets the id of this MyAuthenticationFactorInitiator.
`idcs_created_by`	Gets the idcs_created_by of this MyAuthenticationFactorInitiator.
`idcs_last_modified_by`	Gets the idcs_last_modified_by of this MyAuthenticationFactorInitiator.
`idcs_last_upgraded_in_release`	Gets the idcs_last_upgraded_in_release of this MyAuthenticationFactorInitiator.
`idcs_prevented_operations`	Gets the idcs_prevented_operations of this MyAuthenticationFactorInitiator.
`is_acc_rec_enabled`	Gets the is_acc_rec_enabled of this MyAuthenticationFactorInitiator.
`meta`	Gets the meta of this MyAuthenticationFactorInitiator.
`ocid`	Gets the ocid of this MyAuthenticationFactorInitiator.
`preference_type`	Gets the preference_type of this MyAuthenticationFactorInitiator.
`request_id`	Gets the request_id of this MyAuthenticationFactorInitiator.
`scenario`	Gets the scenario of this MyAuthenticationFactorInitiator.
`schemas`	[Required] Gets the schemas of this MyAuthenticationFactorInitiator.
`tags`	Gets the tags of this MyAuthenticationFactorInitiator.
`tenancy_ocid`	Gets the tenancy_ocid of this MyAuthenticationFactorInitiator.
`third_party_factor`	Gets the third_party_factor of this MyAuthenticationFactorInitiator.
`type`	Gets the type of this MyAuthenticationFactorInitiator.
`user_name`	Gets the user_name of this MyAuthenticationFactorInitiator.

Methods

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

AUTH_FACTOR_EMAIL = 'EMAIL'¶: A constant which can be used with the auth_factor property of a MyAuthenticationFactorInitiator. This constant has a value of “EMAIL”

AUTH_FACTOR_FIDO_AUTHENTICATOR = 'FIDO_AUTHENTICATOR'¶: A constant which can be used with the auth_factor property of a MyAuthenticationFactorInitiator. This constant has a value of “FIDO_AUTHENTICATOR”

AUTH_FACTOR_PHONE_CALL = 'PHONE_CALL'¶: A constant which can be used with the auth_factor property of a MyAuthenticationFactorInitiator. This constant has a value of “PHONE_CALL”

AUTH_FACTOR_PUSH = 'PUSH'¶: A constant which can be used with the auth_factor property of a MyAuthenticationFactorInitiator. This constant has a value of “PUSH”

AUTH_FACTOR_SMS = 'SMS'¶: A constant which can be used with the auth_factor property of a MyAuthenticationFactorInitiator. This constant has a value of “SMS”

AUTH_FACTOR_THIRDPARTY = 'THIRDPARTY'¶: A constant which can be used with the auth_factor property of a MyAuthenticationFactorInitiator. This constant has a value of “THIRDPARTY”

AUTH_FACTOR_TOTP = 'TOTP'¶: A constant which can be used with the auth_factor property of a MyAuthenticationFactorInitiator. This constant has a value of “TOTP”

AUTH_FACTOR_VOICE = 'VOICE'¶: A constant which can be used with the auth_factor property of a MyAuthenticationFactorInitiator. This constant has a value of “VOICE”

AUTH_FACTOR_YUBICO_OTP = 'YUBICO_OTP'¶: A constant which can be used with the auth_factor property of a MyAuthenticationFactorInitiator. This constant has a value of “YUBICO_OTP”

IDCS_PREVENTED_OPERATIONS_DELETE = 'delete'¶: A constant which can be used with the idcs_prevented_operations property of a MyAuthenticationFactorInitiator. This constant has a value of “delete”

IDCS_PREVENTED_OPERATIONS_REPLACE = 'replace'¶: A constant which can be used with the idcs_prevented_operations property of a MyAuthenticationFactorInitiator. This constant has a value of “replace”

IDCS_PREVENTED_OPERATIONS_UPDATE = 'update'¶: A constant which can be used with the idcs_prevented_operations property of a MyAuthenticationFactorInitiator. This constant has a value of “update”

PREFERENCE_TYPE_MFA = 'MFA'¶: A constant which can be used with the preference_type property of a MyAuthenticationFactorInitiator. This constant has a value of “MFA”

PREFERENCE_TYPE_PASSWORDLESS = 'PASSWORDLESS'¶: A constant which can be used with the preference_type property of a MyAuthenticationFactorInitiator. This constant has a value of “PASSWORDLESS”

SCENARIO_AUTHENTICATION = 'AUTHENTICATION'¶: A constant which can be used with the scenario property of a MyAuthenticationFactorInitiator. This constant has a value of “AUTHENTICATION”

SCENARIO_ENROLLMENT = 'ENROLLMENT'¶: A constant which can be used with the scenario property of a MyAuthenticationFactorInitiator. This constant has a value of “ENROLLMENT”

TYPE_OIDC = 'OIDC'¶: A constant which can be used with the type property of a MyAuthenticationFactorInitiator. This constant has a value of “OIDC”

TYPE_SAML = 'SAML'¶: A constant which can be used with the type property of a MyAuthenticationFactorInitiator. This constant has a value of “SAML”

__init__(**kwargs)¶

Initializes a new MyAuthenticationFactorInitiator 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 MyAuthenticationFactorInitiator.
ocid (str) – The value to assign to the ocid property of this MyAuthenticationFactorInitiator.
schemas (list[str]) – The value to assign to the schemas property of this MyAuthenticationFactorInitiator.
meta (oci.identity_domains.models.Meta) – The value to assign to the meta property of this MyAuthenticationFactorInitiator.
idcs_created_by (oci.identity_domains.models.IdcsCreatedBy) – The value to assign to the idcs_created_by property of this MyAuthenticationFactorInitiator.
idcs_last_modified_by (oci.identity_domains.models.IdcsLastModifiedBy) – The value to assign to the idcs_last_modified_by property of this MyAuthenticationFactorInitiator.
idcs_prevented_operations (list[str]) – The value to assign to the idcs_prevented_operations property of this MyAuthenticationFactorInitiator. Allowed values for items in this list are: “replace”, “update”, “delete”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
tags (list[oci.identity_domains.models.Tags]) – The value to assign to the tags property of this MyAuthenticationFactorInitiator.
delete_in_progress (bool) – The value to assign to the delete_in_progress property of this MyAuthenticationFactorInitiator.
idcs_last_upgraded_in_release (str) – The value to assign to the idcs_last_upgraded_in_release property of this MyAuthenticationFactorInitiator.
domain_ocid (str) – The value to assign to the domain_ocid property of this MyAuthenticationFactorInitiator.
compartment_ocid (str) – The value to assign to the compartment_ocid property of this MyAuthenticationFactorInitiator.
tenancy_ocid (str) – The value to assign to the tenancy_ocid property of this MyAuthenticationFactorInitiator.
auth_factor (str) – The value to assign to the auth_factor property of this MyAuthenticationFactorInitiator. Allowed values for this property are: “EMAIL”, “TOTP”, “PUSH”, “SMS”, “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’.
device_id (str) – The value to assign to the device_id property of this MyAuthenticationFactorInitiator.
type (str) – The value to assign to the type property of this MyAuthenticationFactorInitiator. Allowed values for this property are: “SAML”, “OIDC”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
request_id (str) – The value to assign to the request_id property of this MyAuthenticationFactorInitiator.
user_name (str) – The value to assign to the user_name property of this MyAuthenticationFactorInitiator.
scenario (str) – The value to assign to the scenario property of this MyAuthenticationFactorInitiator. Allowed values for this property are: “ENROLLMENT”, “AUTHENTICATION”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
third_party_factor (oci.identity_domains.models.MyAuthenticationFactorInitiatorThirdPartyFactor) – The value to assign to the third_party_factor property of this MyAuthenticationFactorInitiator.
preference_type (str) – The value to assign to the preference_type property of this MyAuthenticationFactorInitiator. Allowed values for this property are: “PASSWORDLESS”, “MFA”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
additional_attributes (list[oci.identity_domains.models.MyAuthenticationFactorInitiatorAdditionalAttributes]) – The value to assign to the additional_attributes property of this MyAuthenticationFactorInitiator.
is_acc_rec_enabled (bool) – The value to assign to the is_acc_rec_enabled property of this MyAuthenticationFactorInitiator.

additional_attributes¶

Gets the additional_attributes of this MyAuthenticationFactorInitiator. Additional attributes which will be sent as part of a push notification

SCIM++ Properties:

idcsSearchable: false
multiValued: true
mutability: readWrite
required: false
returned: default
type: complex
uniqueness: none

Returns:	The additional_attributes of this MyAuthenticationFactorInitiator.
Return type:	list[oci.identity_domains.models.MyAuthenticationFactorInitiatorAdditionalAttributes]

auth_factor¶

[Required] Gets the auth_factor of this MyAuthenticationFactorInitiator. Auth Factor represents the type of multi-factor authentication channel for which the request has been initiated.

SCIM++ Properties:

idcsSearchable: false
multiValued: false
mutability: readWrite
required: true
returned: default
type: string
uniqueness: none

Allowed values for this property are: “EMAIL”, “TOTP”, “PUSH”, “SMS”, “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 auth_factor of this MyAuthenticationFactorInitiator.
Return type:	str

compartment_ocid¶

Gets the compartment_ocid of this MyAuthenticationFactorInitiator. OCI Compartment Id (ocid) in which the resource lives.

SCIM++ Properties:

caseExact: false
idcsSearchable: false
multiValued: false
mutability: readOnly
required: false
returned: default
type: string
uniqueness: none

Returns:	The compartment_ocid of this MyAuthenticationFactorInitiator.
Return type:	str

delete_in_progress¶

Gets the delete_in_progress of this MyAuthenticationFactorInitiator. A boolean flag indicating this resource in the process of being deleted. Usually set to true when synchronous deletion of the resource would take too long.

SCIM++ Properties:

caseExact: false
idcsSearchable: true
multiValued: false
mutability: readOnly
required: false
returned: default
type: boolean
uniqueness: none

Returns:	The delete_in_progress of this MyAuthenticationFactorInitiator.
Return type:	bool

device_id¶

[Required] Gets the device_id of this MyAuthenticationFactorInitiator. Enrolled Device id on which the multi factor has been initiated.

SCIM++ Properties:

caseExact: true
idcsSearchable: false
multiValued: false
mutability: readWrite
required: true
returned: default
type: string
uniqueness: none

Returns:	The device_id of this MyAuthenticationFactorInitiator.
Return type:	str

domain_ocid¶

Gets the domain_ocid of this MyAuthenticationFactorInitiator. OCI Domain Id (ocid) in which the resource lives.

SCIM++ Properties:

caseExact: false
idcsSearchable: false
multiValued: false
mutability: readOnly
required: false
returned: default
type: string
uniqueness: none

Returns:	The domain_ocid of this MyAuthenticationFactorInitiator.
Return type:	str

id¶

Gets the id of this MyAuthenticationFactorInitiator. Unique identifier for the SCIM Resource as defined by the Service Provider. Each representation of the Resource MUST include a non-empty id value. This identifier MUST be unique across the Service Provider’s entire set of Resources. It MUST be a stable, non-reassignable identifier that does not change when the same Resource is returned in subsequent requests. The value of the id attribute is always issued by the Service Provider and MUST never be specified by the Service Consumer. bulkId: is a reserved keyword and MUST NOT be used in the unique identifier.

SCIM++ Properties:

caseExact: false
idcsSearchable: true
multiValued: false
mutability: readOnly
required: false
returned: always
type: string
uniqueness: global

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

idcs_created_by¶

Gets the idcs_created_by of this MyAuthenticationFactorInitiator.

Returns:	The idcs_created_by of this MyAuthenticationFactorInitiator.
Return type:	oci.identity_domains.models.IdcsCreatedBy

idcs_last_modified_by¶

Gets the idcs_last_modified_by of this MyAuthenticationFactorInitiator.

Returns:	The idcs_last_modified_by of this MyAuthenticationFactorInitiator.
Return type:	oci.identity_domains.models.IdcsLastModifiedBy

idcs_last_upgraded_in_release¶

Gets the idcs_last_upgraded_in_release of this MyAuthenticationFactorInitiator. The release number when the resource was upgraded.

SCIM++ Properties:

caseExact: false
idcsSearchable: false
multiValued: false
mutability: readOnly
required: false
returned: request
type: string
uniqueness: none

Returns:	The idcs_last_upgraded_in_release of this MyAuthenticationFactorInitiator.
Return type:	str

idcs_prevented_operations¶

Gets the idcs_prevented_operations of this MyAuthenticationFactorInitiator. Each value of this attribute specifies an operation that only an internal client may perform on this particular resource.

SCIM++ Properties:

idcsSearchable: false
multiValued: true
mutability: readOnly
required: false
returned: request
type: string
uniqueness: none

Allowed values for items in this list are: “replace”, “update”, “delete”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:	The idcs_prevented_operations of this MyAuthenticationFactorInitiator.
Return type:	list[str]

is_acc_rec_enabled¶

Gets the is_acc_rec_enabled of this MyAuthenticationFactorInitiator. Flag indicates whether the device is enrolled in account recovery

SCIM++ Properties:

caseExact: true
idcsSearchable: true
multiValued: false
mutability: readWrite
required: false
returned: default
type: boolean
uniqueness: none

Returns:	The is_acc_rec_enabled of this MyAuthenticationFactorInitiator.
Return type:	bool

meta¶

Gets the meta of this MyAuthenticationFactorInitiator.

Returns:	The meta of this MyAuthenticationFactorInitiator.
Return type:	oci.identity_domains.models.Meta

ocid¶

Gets the ocid of this MyAuthenticationFactorInitiator. Unique OCI identifier for the SCIM Resource.

SCIM++ Properties:

caseExact: true
idcsSearchable: true
multiValued: false
mutability: immutable
required: false
returned: default
type: string
uniqueness: global

Returns:	The ocid of this MyAuthenticationFactorInitiator.
Return type:	str

preference_type¶

Gets the preference_type of this MyAuthenticationFactorInitiator. Indicates whether to user passwordless factor to be updated or mfa factor to be updated

SCIM++ Properties:

type: string
multiValued: false
required: false
mutability: writeOnly
returned: never
uniqueness: none

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

Returns:	The preference_type of this MyAuthenticationFactorInitiator.
Return type:	str

request_id¶

Gets the request_id of this MyAuthenticationFactorInitiator. Unique RequestId generated for each initiator request.

SCIM++ Properties:

caseExact: true
idcsSearchable: false
multiValued: false
mutability: readWrite
required: false
returned: default
type: string
uniqueness: none

Returns:	The request_id of this MyAuthenticationFactorInitiator.
Return type:	str

scenario¶

Gets the scenario of this MyAuthenticationFactorInitiator. Specifies the scenario to initiate.

SCIM++ Properties:

type: string
multiValued: false
required: false
mutability: readWrite
returned: default
uniqueness: none
idcsSearchable: false

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

Returns:	The scenario of this MyAuthenticationFactorInitiator.
Return type:	str

schemas¶

[Required] Gets the schemas of this MyAuthenticationFactorInitiator. REQUIRED. The schemas attribute is an array of Strings which allows introspection of the supported schema version for a SCIM representation as well any schema extensions supported by that representation. Each String value must be a unique URI. This specification defines URIs for User, Group, and a standard “enterprise” extension. All representations of SCIM schema MUST include a non-zero value array with value(s) of the URIs supported by that representation. Duplicate values MUST NOT be included. Value order is not specified and MUST not impact behavior.

SCIM++ Properties:

caseExact: false
idcsSearchable: false
multiValued: true
mutability: readWrite
required: true
returned: default
type: string
uniqueness: none

Returns:	The schemas of this MyAuthenticationFactorInitiator.
Return type:	list[str]

tags¶

Gets the tags of this MyAuthenticationFactorInitiator. A list of tags on this resource.

SCIM++ Properties:

idcsCompositeKey: [key, value]
idcsSearchable: true
multiValued: true
mutability: readWrite
required: false
returned: request
type: complex
uniqueness: none

Returns:	The tags of this MyAuthenticationFactorInitiator.
Return type:	list[oci.identity_domains.models.Tags]

tenancy_ocid¶

Gets the tenancy_ocid of this MyAuthenticationFactorInitiator. OCI Tenant Id (ocid) in which the resource lives.

SCIM++ Properties:

caseExact: false
idcsSearchable: false
multiValued: false
mutability: readOnly
required: false
returned: default
type: string
uniqueness: none

Returns:	The tenancy_ocid of this MyAuthenticationFactorInitiator.
Return type:	str

third_party_factor¶

Gets the third_party_factor of this MyAuthenticationFactorInitiator.

Returns:	The third_party_factor of this MyAuthenticationFactorInitiator.
Return type:	oci.identity_domains.models.MyAuthenticationFactorInitiatorThirdPartyFactor

type¶

Gets the type of this MyAuthenticationFactorInitiator. Authentication flow type either SAML / OIDC

SCIM++ Properties:

caseExact: true
idcsSearchable: false
multiValued: false
mutability: readWrite
required: false
returned: default
type: string
uniqueness: none

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

Returns:	The type of this MyAuthenticationFactorInitiator.
Return type:	str

user_name¶

Gets the user_name of this MyAuthenticationFactorInitiator. Name of the user who initiates the request.

SCIM++ Properties:

caseExact: true
idcsSearchable: false
multiValued: false
mutability: readWrite
required: false
returned: default
type: string
uniqueness: none
idcsPii: true

Returns:	The user_name of this MyAuthenticationFactorInitiator.
Return type:	str