AccountRecoverySetting¶

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

Bases: object

Account Recovery Settings

Attributes

`FACTORS_EMAIL`	A constant which can be used with the factors property of a AccountRecoverySetting.
`FACTORS_PUSH`	A constant which can be used with the factors property of a AccountRecoverySetting.
`FACTORS_SECQUESTIONS`	A constant which can be used with the factors property of a AccountRecoverySetting.
`FACTORS_SMS`	A constant which can be used with the factors property of a AccountRecoverySetting.
`FACTORS_TOTP`	A constant which can be used with the factors property of a AccountRecoverySetting.
`IDCS_PREVENTED_OPERATIONS_DELETE`	A constant which can be used with the idcs_prevented_operations property of a AccountRecoverySetting.
`IDCS_PREVENTED_OPERATIONS_REPLACE`	A constant which can be used with the idcs_prevented_operations property of a AccountRecoverySetting.
`IDCS_PREVENTED_OPERATIONS_UPDATE`	A constant which can be used with the idcs_prevented_operations property of a AccountRecoverySetting.
`compartment_ocid`	Gets the compartment_ocid of this AccountRecoverySetting.
`delete_in_progress`	Gets the delete_in_progress of this AccountRecoverySetting.
`domain_ocid`	Gets the domain_ocid of this AccountRecoverySetting.
`external_id`	Gets the external_id of this AccountRecoverySetting.
`factors`	[Required] Gets the factors of this AccountRecoverySetting.
`id`	Gets the id of this AccountRecoverySetting.
`idcs_created_by`	Gets the idcs_created_by of this AccountRecoverySetting.
`idcs_last_modified_by`	Gets the idcs_last_modified_by of this AccountRecoverySetting.
`idcs_last_upgraded_in_release`	Gets the idcs_last_upgraded_in_release of this AccountRecoverySetting.
`idcs_prevented_operations`	Gets the idcs_prevented_operations of this AccountRecoverySetting.
`lockout_duration`	[Required] Gets the lockout_duration of this AccountRecoverySetting.
`max_incorrect_attempts`	[Required] Gets the max_incorrect_attempts of this AccountRecoverySetting.
`meta`	Gets the meta of this AccountRecoverySetting.
`ocid`	Gets the ocid of this AccountRecoverySetting.
`schemas`	[Required] Gets the schemas of this AccountRecoverySetting.
`tags`	Gets the tags of this AccountRecoverySetting.
`tenancy_ocid`	Gets the tenancy_ocid of this AccountRecoverySetting.

Methods

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

FACTORS_EMAIL = 'email'¶: A constant which can be used with the factors property of a AccountRecoverySetting. This constant has a value of “email”

FACTORS_PUSH = 'push'¶: A constant which can be used with the factors property of a AccountRecoverySetting. This constant has a value of “push”

FACTORS_SECQUESTIONS = 'secquestions'¶: A constant which can be used with the factors property of a AccountRecoverySetting. This constant has a value of “secquestions”

FACTORS_SMS = 'sms'¶: A constant which can be used with the factors property of a AccountRecoverySetting. This constant has a value of “sms”

FACTORS_TOTP = 'totp'¶: A constant which can be used with the factors property of a AccountRecoverySetting. This constant has a value of “totp”

IDCS_PREVENTED_OPERATIONS_DELETE = 'delete'¶: A constant which can be used with the idcs_prevented_operations property of a AccountRecoverySetting. 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 AccountRecoverySetting. 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 AccountRecoverySetting. This constant has a value of “update”

__init__(**kwargs)¶

Initializes a new AccountRecoverySetting 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 AccountRecoverySetting.
ocid (str) – The value to assign to the ocid property of this AccountRecoverySetting.
schemas (list[str]) – The value to assign to the schemas property of this AccountRecoverySetting.
meta (oci.identity_domains.models.Meta) – The value to assign to the meta property of this AccountRecoverySetting.
idcs_created_by (oci.identity_domains.models.IdcsCreatedBy) – The value to assign to the idcs_created_by property of this AccountRecoverySetting.
idcs_last_modified_by (oci.identity_domains.models.IdcsLastModifiedBy) – The value to assign to the idcs_last_modified_by property of this AccountRecoverySetting.
idcs_prevented_operations (list[str]) – The value to assign to the idcs_prevented_operations property of this AccountRecoverySetting. 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 AccountRecoverySetting.
delete_in_progress (bool) – The value to assign to the delete_in_progress property of this AccountRecoverySetting.
idcs_last_upgraded_in_release (str) – The value to assign to the idcs_last_upgraded_in_release property of this AccountRecoverySetting.
domain_ocid (str) – The value to assign to the domain_ocid property of this AccountRecoverySetting.
compartment_ocid (str) – The value to assign to the compartment_ocid property of this AccountRecoverySetting.
tenancy_ocid (str) – The value to assign to the tenancy_ocid property of this AccountRecoverySetting.
external_id (str) – The value to assign to the external_id property of this AccountRecoverySetting.
factors (list[str]) – The value to assign to the factors property of this AccountRecoverySetting. Allowed values for items in this list are: “email”, “sms”, “secquestions”, “push”, “totp”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
max_incorrect_attempts (int) – The value to assign to the max_incorrect_attempts property of this AccountRecoverySetting.
lockout_duration (int) – The value to assign to the lockout_duration property of this AccountRecoverySetting.

compartment_ocid¶

Gets the compartment_ocid of this AccountRecoverySetting. 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 AccountRecoverySetting.
Return type:	str

delete_in_progress¶

Gets the delete_in_progress of this AccountRecoverySetting. 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 AccountRecoverySetting.
Return type:	bool

domain_ocid¶

Gets the domain_ocid of this AccountRecoverySetting. 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 AccountRecoverySetting.
Return type:	str

external_id¶

Gets the external_id of this AccountRecoverySetting. An identifier for the Resource as defined by the Service Consumer. The externalId may simplify identification of the Resource between Service Consumer and Service Provider by allowing the Consumer to refer to the Resource with its own identifier, obviating the need to store a local mapping between the local identifier of the Resource and the identifier used by the Service Provider. Each Resource MAY include a non-empty externalId value. The value of the externalId attribute is always issued by the Service Consumer and can never be specified by the Service Provider. The Service Provider MUST always interpret the externalId as scoped to the Service Consumer’s tenant.

SCIM++ Properties:

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

Returns:	The external_id of this AccountRecoverySetting.
Return type:	str

factors¶

[Required] Gets the factors of this AccountRecoverySetting. The account recovery factor used (for example, email, mobile number (SMS), security questions, mobile application push or TOTP) to verify the identity of the user and reset the user’s password.

SCIM++ Properties:

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

Allowed values for items in this list are: “email”, “sms”, “secquestions”, “push”, “totp”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:	The factors of this AccountRecoverySetting.
Return type:	list[str]

id¶

Gets the id of this AccountRecoverySetting. 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 AccountRecoverySetting.
Return type:	str

idcs_created_by¶

Gets the idcs_created_by of this AccountRecoverySetting.

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

idcs_last_modified_by¶

Gets the idcs_last_modified_by of this AccountRecoverySetting.

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

idcs_last_upgraded_in_release¶

Gets the idcs_last_upgraded_in_release of this AccountRecoverySetting. 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 AccountRecoverySetting.
Return type:	str

idcs_prevented_operations¶

Gets the idcs_prevented_operations of this AccountRecoverySetting. 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 AccountRecoverySetting.
Return type:	list[str]

lockout_duration¶

[Required] Gets the lockout_duration of this AccountRecoverySetting. Indicates how many minutes to disable account recovery for the user. The default value is 30 metric minutes.

SCIM++ Properties:

caseExact: false
multiValued: false
mutability: readWrite
required: true
returned: default
type: integer
uniqueness: none
idcsMinValue: 5
idcsMaxValue: 9999

Returns:	The lockout_duration of this AccountRecoverySetting.
Return type:	int

max_incorrect_attempts¶

[Required] Gets the max_incorrect_attempts of this AccountRecoverySetting. Indicates the maximum number of failed account recovery attempts allowed for the user.

SCIM++ Properties:

caseExact: false
multiValued: false
mutability: readWrite
required: true
returned: default
type: integer
uniqueness: none
idcsMinValue: 1
idcsMaxValue: 99

Returns:	The max_incorrect_attempts of this AccountRecoverySetting.
Return type:	int

meta¶

Gets the meta of this AccountRecoverySetting.

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

ocid¶

Gets the ocid of this AccountRecoverySetting. 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 AccountRecoverySetting.
Return type:	str

schemas¶

[Required] Gets the schemas of this AccountRecoverySetting. 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 AccountRecoverySetting.
Return type:	list[str]

tags¶

Gets the tags of this AccountRecoverySetting. 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 AccountRecoverySetting.
Return type:	list[oci.identity_domains.models.Tags]

tenancy_ocid¶

Gets the tenancy_ocid of this AccountRecoverySetting. 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 AccountRecoverySetting.
Return type:	str