IdentitySetting¶

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

Bases: object

Identity Settings

Attributes

`IDCS_PREVENTED_OPERATIONS_DELETE`	A constant which can be used with the idcs_prevented_operations property of a IdentitySetting.
`IDCS_PREVENTED_OPERATIONS_REPLACE`	A constant which can be used with the idcs_prevented_operations property of a IdentitySetting.
`IDCS_PREVENTED_OPERATIONS_UPDATE`	A constant which can be used with the idcs_prevented_operations property of a IdentitySetting.
`compartment_ocid`	Gets the compartment_ocid of this IdentitySetting.
`delete_in_progress`	Gets the delete_in_progress of this IdentitySetting.
`domain_ocid`	Gets the domain_ocid of this IdentitySetting.
`emit_locked_message_when_user_is_locked`	Gets the emit_locked_message_when_user_is_locked of this IdentitySetting.
`external_id`	Gets the external_id of this IdentitySetting.
`id`	Gets the id of this IdentitySetting.
`idcs_created_by`	Gets the idcs_created_by of this IdentitySetting.
`idcs_last_modified_by`	Gets the idcs_last_modified_by of this IdentitySetting.
`idcs_last_upgraded_in_release`	Gets the idcs_last_upgraded_in_release of this IdentitySetting.
`idcs_prevented_operations`	Gets the idcs_prevented_operations of this IdentitySetting.
`meta`	Gets the meta of this IdentitySetting.
`my_profile`	Gets the my_profile of this IdentitySetting.
`ocid`	Gets the ocid of this IdentitySetting.
`posix_gid`	Gets the posix_gid of this IdentitySetting.
`posix_uid`	Gets the posix_uid of this IdentitySetting.
`primary_email_required`	Gets the primary_email_required of this IdentitySetting.
`remove_invalid_emails`	Gets the remove_invalid_emails of this IdentitySetting.
`return_inactive_over_locked_message`	Gets the return_inactive_over_locked_message of this IdentitySetting.
`schemas`	[Required] Gets the schemas of this IdentitySetting.
`tags`	Gets the tags of this IdentitySetting.
`tenancy_ocid`	Gets the tenancy_ocid of this IdentitySetting.
`tokens`	Gets the tokens of this IdentitySetting.
`user_allowed_to_set_recovery_email`	Gets the user_allowed_to_set_recovery_email of this IdentitySetting.

Methods

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

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

__init__(**kwargs)¶

Initializes a new IdentitySetting 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 IdentitySetting.
ocid (str) – The value to assign to the ocid property of this IdentitySetting.
schemas (list[str]) – The value to assign to the schemas property of this IdentitySetting.
meta (oci.identity_domains.models.Meta) – The value to assign to the meta property of this IdentitySetting.
idcs_created_by (oci.identity_domains.models.IdcsCreatedBy) – The value to assign to the idcs_created_by property of this IdentitySetting.
idcs_last_modified_by (oci.identity_domains.models.IdcsLastModifiedBy) – The value to assign to the idcs_last_modified_by property of this IdentitySetting.
idcs_prevented_operations (list[str]) – The value to assign to the idcs_prevented_operations property of this IdentitySetting. 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 IdentitySetting.
delete_in_progress (bool) – The value to assign to the delete_in_progress property of this IdentitySetting.
idcs_last_upgraded_in_release (str) – The value to assign to the idcs_last_upgraded_in_release property of this IdentitySetting.
domain_ocid (str) – The value to assign to the domain_ocid property of this IdentitySetting.
compartment_ocid (str) – The value to assign to the compartment_ocid property of this IdentitySetting.
tenancy_ocid (str) – The value to assign to the tenancy_ocid property of this IdentitySetting.
external_id (str) – The value to assign to the external_id property of this IdentitySetting.
user_allowed_to_set_recovery_email (bool) – The value to assign to the user_allowed_to_set_recovery_email property of this IdentitySetting.
emit_locked_message_when_user_is_locked (bool) – The value to assign to the emit_locked_message_when_user_is_locked property of this IdentitySetting.
primary_email_required (bool) – The value to assign to the primary_email_required property of this IdentitySetting.
remove_invalid_emails (bool) – The value to assign to the remove_invalid_emails property of this IdentitySetting.
return_inactive_over_locked_message (bool) – The value to assign to the return_inactive_over_locked_message property of this IdentitySetting.
my_profile (oci.identity_domains.models.IdentitySettingsMyProfile) – The value to assign to the my_profile property of this IdentitySetting.
posix_uid (oci.identity_domains.models.IdentitySettingsPOSIXUid) – The value to assign to the posix_uid property of this IdentitySetting.
posix_gid (oci.identity_domains.models.IdentitySettingsPOSIXGid) – The value to assign to the posix_gid property of this IdentitySetting.
tokens (list[oci.identity_domains.models.IdentitySettingsTokens]) – The value to assign to the tokens property of this IdentitySetting.

compartment_ocid¶

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

delete_in_progress¶

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

domain_ocid¶

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

emit_locked_message_when_user_is_locked¶

Gets the emit_locked_message_when_user_is_locked of this IdentitySetting. Indicates whether to show the ‘user-is-locked’ message during authentication if the user is already locked. The default value is false, which tells the system to show a generic ‘authentication-failure’ message. This is the most secure behavior. If the option is set to true, the system shows a more detailed ‘error-message’ that says the user is locked. This is more helpful but is less secure, for example, because the difference in error-messages could be used to determine which usernames exist and which do not.

Added In: 19.2.1

SCIM++ Properties:

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

Returns:	The emit_locked_message_when_user_is_locked of this IdentitySetting.
Return type:	bool

external_id¶

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

id¶

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

idcs_created_by¶

Gets the idcs_created_by of this IdentitySetting.

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

idcs_last_modified_by¶

Gets the idcs_last_modified_by of this IdentitySetting.

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

idcs_last_upgraded_in_release¶

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

idcs_prevented_operations¶

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

meta¶

Gets the meta of this IdentitySetting.

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

my_profile¶

Gets the my_profile of this IdentitySetting.

Returns:	The my_profile of this IdentitySetting.
Return type:	oci.identity_domains.models.IdentitySettingsMyProfile

ocid¶

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

posix_gid¶

Gets the posix_gid of this IdentitySetting.

Returns:	The posix_gid of this IdentitySetting.
Return type:	oci.identity_domains.models.IdentitySettingsPOSIXGid

posix_uid¶

Gets the posix_uid of this IdentitySetting.

Returns:	The posix_uid of this IdentitySetting.
Return type:	oci.identity_domains.models.IdentitySettingsPOSIXUid

primary_email_required¶

Gets the primary_email_required of this IdentitySetting. Indicates whether the primary email is required.

Added In: 19.1.4

SCIM++ Properties:

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

Returns:	The primary_email_required of this IdentitySetting.
Return type:	bool

remove_invalid_emails¶

Gets the remove_invalid_emails of this IdentitySetting. Indicates whether to remove non-RFC5322 compliant emails before creating a user.

Added In: 2106170416

SCIM++ Properties:

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

Returns:	The remove_invalid_emails of this IdentitySetting.
Return type:	bool

return_inactive_over_locked_message¶

Gets the return_inactive_over_locked_message of this IdentitySetting. Added In: 2302092332

SCIM++ Properties: - caseExact: false - multiValued: false - mutability: readWrite - required: false - returned: default - type: boolean - uniqueness: none Determines the PasswordAuthenticator API response when a user is both ‘locked’ and ‘inactive.’ If false (default), a ‘locked’ message is shown. If true, an ‘inactive’ message is shown.

Returns:	The return_inactive_over_locked_message of this IdentitySetting.
Return type:	bool

schemas¶

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

tags¶

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

tenancy_ocid¶

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

tokens¶

Gets the tokens of this IdentitySetting. A list of tokens and their expiry length.

SCIM++ Properties:

caseExact: false
idcsCompositeKey: [type]
multiValued: true
required: false
type: complex
uniqueness: none

Returns:	The tokens of this IdentitySetting.
Return type:	list[oci.identity_domains.models.IdentitySettingsTokens]

user_allowed_to_set_recovery_email¶

Gets the user_allowed_to_set_recovery_email of this IdentitySetting. Indicates whether a user is allowed to change their own recovery email.

SCIM++ Properties:

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

Returns:	The user_allowed_to_set_recovery_email of this IdentitySetting.
Return type:	bool