Setting¶

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

Bases: object

Settings schema

Attributes

`CSR_ACCESS_NONE`	A constant which can be used with the csr_access property of a Setting.
`CSR_ACCESS_READ_ONLY`	A constant which can be used with the csr_access property of a Setting.
`CSR_ACCESS_READ_WRITE`	A constant which can be used with the csr_access property of a Setting.
`DEFAULT_TRUST_SCOPE_ACCOUNT`	A constant which can be used with the default_trust_scope property of a Setting.
`DEFAULT_TRUST_SCOPE_EXPLICIT`	A constant which can be used with the default_trust_scope property of a Setting.
`DEFAULT_TRUST_SCOPE_TAGS`	A constant which can be used with the default_trust_scope property of a Setting.
`IDCS_PREVENTED_OPERATIONS_DELETE`	A constant which can be used with the idcs_prevented_operations property of a Setting.
`IDCS_PREVENTED_OPERATIONS_REPLACE`	A constant which can be used with the idcs_prevented_operations property of a Setting.
`IDCS_PREVENTED_OPERATIONS_UPDATE`	A constant which can be used with the idcs_prevented_operations property of a Setting.
`RE_AUTH_FACTOR_PASSWORD`	A constant which can be used with the re_auth_factor property of a Setting.
`account_always_trust_scope`	Gets the account_always_trust_scope of this Setting.
`allowed_domains`	Gets the allowed_domains of this Setting.
`allowed_forgot_password_flow_return_urls`	Gets the allowed_forgot_password_flow_return_urls of this Setting.
`allowed_notification_redirect_urls`	Gets the allowed_notification_redirect_urls of this Setting.
`audit_event_retention_period`	Gets the audit_event_retention_period of this Setting.
`certificate_validation`	Gets the certificate_validation of this Setting.
`cloud_account_name`	Gets the cloud_account_name of this Setting.
`cloud_gate_cors_settings`	Gets the cloud_gate_cors_settings of this Setting.
`cloud_migration_custom_url`	Gets the cloud_migration_custom_url of this Setting.
`cloud_migration_url_enabled`	Gets the cloud_migration_url_enabled of this Setting.
`company_names`	Gets the company_names of this Setting.
`compartment_ocid`	Gets the compartment_ocid of this Setting.
`contact_emails`	Gets the contact_emails of this Setting.
`csr_access`	[Required] Gets the csr_access of this Setting.
`custom_branding`	Gets the custom_branding of this Setting.
`custom_css_location`	Gets the custom_css_location of this Setting.
`custom_html_location`	Gets the custom_html_location of this Setting.
`custom_translation`	Gets the custom_translation of this Setting.
`default_company_names`	Gets the default_company_names of this Setting.
`default_images`	Gets the default_images of this Setting.
`default_login_texts`	Gets the default_login_texts of this Setting.
`default_trust_scope`	Gets the default_trust_scope of this Setting.
`delete_in_progress`	Gets the delete_in_progress of this Setting.
`diagnostic_level`	Gets the diagnostic_level of this Setting.
`diagnostic_record_for_search_identifies_returned_resources`	Gets the diagnostic_record_for_search_identifies_returned_resources of this Setting.
`diagnostic_tracing_upto`	Gets the diagnostic_tracing_upto of this Setting.
`domain_ocid`	Gets the domain_ocid of this Setting.
`enable_terms_of_use`	Gets the enable_terms_of_use of this Setting.
`external_id`	Gets the external_id of this Setting.
`iam_upst_session_expiry`	Gets the iam_upst_session_expiry of this Setting.
`id`	Gets the id of this Setting.
`idcs_created_by`	Gets the idcs_created_by of this Setting.
`idcs_last_modified_by`	Gets the idcs_last_modified_by of this Setting.
`idcs_last_upgraded_in_release`	Gets the idcs_last_upgraded_in_release of this Setting.
`idcs_prevented_operations`	Gets the idcs_prevented_operations of this Setting.
`images`	Gets the images of this Setting.
`is_hosted_page`	Gets the is_hosted_page of this Setting.
`issuer`	Gets the issuer of this Setting.
`locale`	Gets the locale of this Setting.
`login_texts`	Gets the login_texts of this Setting.
`max_no_of_app_cmva_to_return`	Gets the max_no_of_app_cmva_to_return of this Setting.
`max_no_of_app_role_members_to_return`	Gets the max_no_of_app_role_members_to_return of this Setting.
`meta`	Gets the meta of this Setting.
`migration_status`	Gets the migration_status of this Setting.
`ocid`	Gets the ocid of this Setting.
`on_premises_provisioning`	Gets the on_premises_provisioning of this Setting.
`preferred_language`	Gets the preferred_language of this Setting.
`prev_issuer`	Gets the prev_issuer of this Setting.
`privacy_policy_url`	Gets the privacy_policy_url of this Setting.
`purge_configs`	Gets the purge_configs of this Setting.
`re_auth_factor`	Gets the re_auth_factor of this Setting.
`re_auth_when_changing_my_authentication_factors`	Gets the re_auth_when_changing_my_authentication_factors of this Setting.
`schemas`	[Required] Gets the schemas of this Setting.
`service_admin_cannot_list_other_users`	Gets the service_admin_cannot_list_other_users of this Setting.
`signing_cert_public_access`	Gets the signing_cert_public_access of this Setting.
`sub_mapping_attr`	Gets the sub_mapping_attr of this Setting.
`tags`	Gets the tags of this Setting.
`tenancy_ocid`	Gets the tenancy_ocid of this Setting.
`tenant_custom_claims`	Gets the tenant_custom_claims of this Setting.
`terms_of_use_url`	Gets the terms_of_use_url of this Setting.
`timezone`	Gets the timezone of this Setting.

Methods

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

CSR_ACCESS_NONE = 'none'¶: A constant which can be used with the csr_access property of a Setting. This constant has a value of “none”

CSR_ACCESS_READ_ONLY = 'readOnly'¶: A constant which can be used with the csr_access property of a Setting. This constant has a value of “readOnly”

CSR_ACCESS_READ_WRITE = 'readWrite'¶: A constant which can be used with the csr_access property of a Setting. This constant has a value of “readWrite”

DEFAULT_TRUST_SCOPE_ACCOUNT = 'Account'¶: A constant which can be used with the default_trust_scope property of a Setting. This constant has a value of “Account”

DEFAULT_TRUST_SCOPE_EXPLICIT = 'Explicit'¶: A constant which can be used with the default_trust_scope property of a Setting. This constant has a value of “Explicit”

DEFAULT_TRUST_SCOPE_TAGS = 'Tags'¶: A constant which can be used with the default_trust_scope property of a Setting. This constant has a value of “Tags”

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

RE_AUTH_FACTOR_PASSWORD = 'password'¶: A constant which can be used with the re_auth_factor property of a Setting. This constant has a value of “password”

__init__(**kwargs)¶

Initializes a new Setting 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 Setting.
ocid (str) – The value to assign to the ocid property of this Setting.
schemas (list[str]) – The value to assign to the schemas property of this Setting.
meta (oci.identity_domains.models.Meta) – The value to assign to the meta property of this Setting.
idcs_created_by (oci.identity_domains.models.IdcsCreatedBy) – The value to assign to the idcs_created_by property of this Setting.
idcs_last_modified_by (oci.identity_domains.models.IdcsLastModifiedBy) – The value to assign to the idcs_last_modified_by property of this Setting.
idcs_prevented_operations (list[str]) – The value to assign to the idcs_prevented_operations property of this Setting. 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 Setting.
delete_in_progress (bool) – The value to assign to the delete_in_progress property of this Setting.
idcs_last_upgraded_in_release (str) – The value to assign to the idcs_last_upgraded_in_release property of this Setting.
domain_ocid (str) – The value to assign to the domain_ocid property of this Setting.
compartment_ocid (str) – The value to assign to the compartment_ocid property of this Setting.
tenancy_ocid (str) – The value to assign to the tenancy_ocid property of this Setting.
external_id (str) – The value to assign to the external_id property of this Setting.
contact_emails (list[str]) – The value to assign to the contact_emails property of this Setting.
custom_branding (bool) – The value to assign to the custom_branding property of this Setting.
preferred_language (str) – The value to assign to the preferred_language property of this Setting.
timezone (str) – The value to assign to the timezone property of this Setting.
diagnostic_record_for_search_identifies_returned_resources (bool) – The value to assign to the diagnostic_record_for_search_identifies_returned_resources property of this Setting.
re_auth_when_changing_my_authentication_factors (bool) – The value to assign to the re_auth_when_changing_my_authentication_factors property of this Setting.
re_auth_factor (list[str]) – The value to assign to the re_auth_factor property of this Setting. Allowed values for items in this list are: “password”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
locale (str) – The value to assign to the locale property of this Setting.
csr_access (str) – The value to assign to the csr_access property of this Setting. Allowed values for this property are: “readOnly”, “readWrite”, “none”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
signing_cert_public_access (bool) – The value to assign to the signing_cert_public_access property of this Setting.
sub_mapping_attr (str) – The value to assign to the sub_mapping_attr property of this Setting.
account_always_trust_scope (bool) – The value to assign to the account_always_trust_scope property of this Setting.
default_trust_scope (str) – The value to assign to the default_trust_scope property of this Setting. Allowed values for this property are: “Explicit”, “Account”, “Tags”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
issuer (str) – The value to assign to the issuer property of this Setting.
prev_issuer (str) – The value to assign to the prev_issuer property of this Setting.
diagnostic_level (int) – The value to assign to the diagnostic_level property of this Setting.
diagnostic_tracing_upto (str) – The value to assign to the diagnostic_tracing_upto property of this Setting.
allowed_domains (list[str]) – The value to assign to the allowed_domains property of this Setting.
enable_terms_of_use (bool) – The value to assign to the enable_terms_of_use property of this Setting.
terms_of_use_url (str) – The value to assign to the terms_of_use_url property of this Setting.
privacy_policy_url (str) – The value to assign to the privacy_policy_url property of this Setting.
migration_status (str) – The value to assign to the migration_status property of this Setting.
on_premises_provisioning (bool) – The value to assign to the on_premises_provisioning property of this Setting.
allowed_forgot_password_flow_return_urls (list[str]) – The value to assign to the allowed_forgot_password_flow_return_urls property of this Setting.
allowed_notification_redirect_urls (list[str]) – The value to assign to the allowed_notification_redirect_urls property of this Setting.
audit_event_retention_period (int) – The value to assign to the audit_event_retention_period property of this Setting.
is_hosted_page (bool) – The value to assign to the is_hosted_page property of this Setting.
custom_html_location (str) – The value to assign to the custom_html_location property of this Setting.
custom_css_location (str) – The value to assign to the custom_css_location property of this Setting.
custom_translation (str) – The value to assign to the custom_translation property of this Setting.
cloud_account_name (str) – The value to assign to the cloud_account_name property of this Setting.
cloud_migration_url_enabled (bool) – The value to assign to the cloud_migration_url_enabled property of this Setting.
cloud_migration_custom_url (str) – The value to assign to the cloud_migration_custom_url property of this Setting.
service_admin_cannot_list_other_users (bool) – The value to assign to the service_admin_cannot_list_other_users property of this Setting.
max_no_of_app_role_members_to_return (int) – The value to assign to the max_no_of_app_role_members_to_return property of this Setting.
max_no_of_app_cmva_to_return (int) – The value to assign to the max_no_of_app_cmva_to_return property of this Setting.
iam_upst_session_expiry (int) – The value to assign to the iam_upst_session_expiry property of this Setting.
cloud_gate_cors_settings (oci.identity_domains.models.SettingsCloudGateCorsSettings) – The value to assign to the cloud_gate_cors_settings property of this Setting.
certificate_validation (oci.identity_domains.models.SettingsCertificateValidation) – The value to assign to the certificate_validation property of this Setting.
tenant_custom_claims (list[oci.identity_domains.models.SettingsTenantCustomClaims]) – The value to assign to the tenant_custom_claims property of this Setting.
purge_configs (list[oci.identity_domains.models.SettingsPurgeConfigs]) – The value to assign to the purge_configs property of this Setting.
default_company_names (list[oci.identity_domains.models.SettingsDefaultCompanyNames]) – The value to assign to the default_company_names property of this Setting.
default_login_texts (list[oci.identity_domains.models.SettingsDefaultLoginTexts]) – The value to assign to the default_login_texts property of this Setting.
default_images (list[oci.identity_domains.models.SettingsDefaultImages]) – The value to assign to the default_images property of this Setting.
company_names (list[oci.identity_domains.models.SettingsCompanyNames]) – The value to assign to the company_names property of this Setting.
login_texts (list[oci.identity_domains.models.SettingsLoginTexts]) – The value to assign to the login_texts property of this Setting.
images (list[oci.identity_domains.models.SettingsImages]) – The value to assign to the images property of this Setting.

account_always_trust_scope¶

Gets the account_always_trust_scope of this Setting. Indicates whether all the Apps in this customer tenancy should trust each other. A value of true overrides the ‘defaultTrustScope’ attribute here in Settings, as well as any App-specific ‘trustScope’ attribute, to force in effect ‘trustScope=Account’ for every App in this customer tenancy.

Added In: 18.1.6

SCIM++ Properties:

multiValued: false
mutability: readWrite
required: false
returned: default
type: boolean

Returns:	The account_always_trust_scope of this Setting.
Return type:	bool

allowed_domains¶

Gets the allowed_domains of this Setting. One or more email domains allowed in a user’s email field. If unassigned, any domain is allowed.

SCIM++ Properties:

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

Returns:	The allowed_domains of this Setting.
Return type:	list[str]

allowed_forgot_password_flow_return_urls¶

Gets the allowed_forgot_password_flow_return_urls of this Setting. If specified, indicates the set of Urls which can be returned to after successful forgot password flow

Added In: 19.3.3

SCIM++ Properties:

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

Returns:	The allowed_forgot_password_flow_return_urls of this Setting.
Return type:	list[str]

allowed_notification_redirect_urls¶

Gets the allowed_notification_redirect_urls of this Setting. If specified, indicates the set of allowed notification redirect Urls which can be specified as the value of “notificationRedirectUrl” in the POST …/admin/v1/MePasswordResetRequestor request payload, which will then be included in the reset password email notification sent to a user as part of the forgot password / password reset flow.

Added In: 2009041201

SCIM++ Properties:

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

Returns:	The allowed_notification_redirect_urls of this Setting.
Return type:	list[str]

audit_event_retention_period¶

Gets the audit_event_retention_period of this Setting. Audit Event retention period. If set, overrides default of 30 days after which Audit Events will be purged

Added In: 19.2.1

SCIM++ Properties:

multiValued: false
mutability: readWrite
required: false
returned: default
type: integer

Returns:	The audit_event_retention_period of this Setting.
Return type:	int

certificate_validation¶

Gets the certificate_validation of this Setting.

Returns:	The certificate_validation of this Setting.
Return type:	oci.identity_domains.models.SettingsCertificateValidation

cloud_account_name¶

Gets the cloud_account_name of this Setting. The attribute to store the cloud account name

Deprecated Since: 2011192329

SCIM++ Properties:

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

Returns:	The cloud_account_name of this Setting.
Return type:	str

cloud_gate_cors_settings¶

Gets the cloud_gate_cors_settings of this Setting.

Returns:	The cloud_gate_cors_settings of this Setting.
Return type:	oci.identity_domains.models.SettingsCloudGateCorsSettings

cloud_migration_custom_url¶

Gets the cloud_migration_custom_url of this Setting. If specified, indicates the custom SIM Migrator Url which can be used while SIM to Oracle Identity Cloud Service CloudAccount Migration.

Added In: 2012271618

SCIM++ Properties:

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

Returns:	The cloud_migration_custom_url of this Setting.
Return type:	str

cloud_migration_url_enabled¶

Gets the cloud_migration_url_enabled of this Setting. CloudAccountMigration: Enable Custom SIM Migrator Url.

Added In: 2012271618

SCIM++ Properties:

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

Returns:	The cloud_migration_url_enabled of this Setting.
Return type:	bool

company_names¶

Gets the company_names of this Setting. Name of the company in different locales

SCIM++ Properties:

idcsCompositeKey: [locale]
multiValued: true
mutability: readWrite
required: false
returned: default
type: complex

Returns:	The company_names of this Setting.
Return type:	list[oci.identity_domains.models.SettingsCompanyNames]

compartment_ocid¶

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

contact_emails¶

Gets the contact_emails of this Setting. Contact emails used to notify tenants. Can be one or more user or group alias emails.

SCIM++ Properties:

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

Returns:	The contact_emails of this Setting.
Return type:	list[str]

csr_access¶

[Required] Gets the csr_access of this Setting. This value indicates whether Customer Service Representatives can login and have readOnly or readWrite access. A value of ‘none’ means CSR cannot login to the services.

SCIM++ Properties:

multiValued: false
mutability: readWrite
required: true
returned: default
type: string

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

Returns:	The csr_access of this Setting.
Return type:	str

custom_branding¶

Gets the custom_branding of this Setting. Indicates if the branding is default or custom

SCIM++ Properties:

multiValued: false
mutability: readWrite
required: false
returned: default
type: boolean

Returns:	The custom_branding of this Setting.
Return type:	bool

custom_css_location¶

Gets the custom_css_location of this Setting. Storage URL location where the sanitized custom css is located

Added In: 20.1.3

SCIM++ Properties:

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

Returns:	The custom_css_location of this Setting.
Return type:	str

custom_html_location¶

Gets the custom_html_location of this Setting. Storage URL location where the sanitized custom html is located

Added In: 20.1.3

SCIM++ Properties:

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

Returns:	The custom_html_location of this Setting.
Return type:	str

custom_translation¶

Gets the custom_translation of this Setting. Custom translations (JSON String)

Added In: 20.1.3

SCIM++ Properties:

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

Returns:	The custom_translation of this Setting.
Return type:	str

default_company_names¶

Gets the default_company_names of this Setting. Default name of the Company in different locales

Added In: 18.2.2

SCIM++ Properties:

idcsCompositeKey: [locale]
multiValued: true
mutability: readOnly
required: false
returned: default
type: complex

Returns:	The default_company_names of this Setting.
Return type:	list[oci.identity_domains.models.SettingsDefaultCompanyNames]

default_images¶

Gets the default_images of this Setting. References to various images

Added In: 18.2.2

SCIM++ Properties:

idcsCompositeKey: [type]
multiValued: true
mutability: readOnly
required: false
returned: default
type: complex

Returns:	The default_images of this Setting.
Return type:	list[oci.identity_domains.models.SettingsDefaultImages]

default_login_texts¶

Gets the default_login_texts of this Setting. Default Login text in different locales

Added In: 18.2.2

SCIM++ Properties:

idcsCompositeKey: [locale]
multiValued: true
mutability: readOnly
required: false
returned: default
type: complex

Returns:	The default_login_texts of this Setting.
Return type:	list[oci.identity_domains.models.SettingsDefaultLoginTexts]

default_trust_scope¶

Gets the default_trust_scope of this Setting. Deprecated Since: 18.3.6

SCIM++ Properties: - multiValued: false - mutability: readWrite - required: false - returned: default - type: string Indicates the default trust scope for all apps

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

Returns:	The default_trust_scope of this Setting.
Return type:	str

delete_in_progress¶

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

diagnostic_level¶

Gets the diagnostic_level of this Setting. The level of diagnostic logging that is currently in effect. A level of 0 (zero) indicates that diagnostic logging is disabled. A level of 1 (one) indicates that diagnostic logging is enabled.

SCIM++ Properties:

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

Returns:	The diagnostic_level of this Setting.
Return type:	int

diagnostic_record_for_search_identifies_returned_resources¶

Gets the diagnostic_record_for_search_identifies_returned_resources of this Setting. Controls whether DiagnosticRecords for external search-operations (against SCIM resource-types in the Admin service) identify returned resources. If true, indicates that for each successful external search-operation at least one DiagnosticRecord will include at least one identifier for each matching resource that is returned in that search-response. If false, no DiagnosticRecord should be expected to identify returned resources for a search-operation. The default value is false.

Added In: 2011192329

SCIM++ Properties:

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

Returns:	The diagnostic_record_for_search_identifies_returned_resources of this Setting.
Return type:	bool

diagnostic_tracing_upto¶

Gets the diagnostic_tracing_upto of this Setting. The end time up to which diagnostic recording is switched on

SCIM++ Properties:

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

Returns:	The diagnostic_tracing_upto of this Setting.
Return type:	str

domain_ocid¶

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

enable_terms_of_use¶

Gets the enable_terms_of_use of this Setting. Indicates if Terms of Use is enabled in UI

Added In: 18.2.4

SCIM++ Properties:

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

Returns:	The enable_terms_of_use of this Setting.
Return type:	bool

external_id¶

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

iam_upst_session_expiry¶

Gets the iam_upst_session_expiry of this Setting. Maximum duration for IAM User Principal Session Token expiry

Added In: 2307071836

SCIM++ Properties:

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

Returns:	The iam_upst_session_expiry of this Setting.
Return type:	int

id¶

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

idcs_created_by¶

Gets the idcs_created_by of this Setting.

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

idcs_last_modified_by¶

Gets the idcs_last_modified_by of this Setting.

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

idcs_last_upgraded_in_release¶

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

idcs_prevented_operations¶

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

images¶

Gets the images of this Setting. References to various images

SCIM++ Properties:

idcsCompositeKey: [type]
multiValued: true
mutability: readWrite
required: false
returned: default
type: complex

Returns:	The images of this Setting.
Return type:	list[oci.identity_domains.models.SettingsImages]

is_hosted_page¶

Gets the is_hosted_page of this Setting. Indicates if ‘hosted’ option was selected

Added In: 20.1.3

SCIM++ Properties:

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

Returns:	The is_hosted_page of this Setting.
Return type:	bool

issuer¶

Gets the issuer of this Setting. Tenant issuer.

Added In: 20.1.3

SCIM++ Properties:

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

Returns:	The issuer of this Setting.
Return type:	str

locale¶

Gets the locale of this Setting. Default location for purposes of localizing items such as currency, date and time format, numerical representations, and so on.

SCIM++ Properties:

caseExact: false
idcsCanonicalValueSourceFilter: attrName eq “locales” and attrValues.value eq “$(locale)”
idcsCanonicalValueSourceResourceType: AllowedValue
multiValued: false
mutability: readWrite
required: false
returned: default
type: string
uniqueness: none

Returns:	The locale of this Setting.
Return type:	str

login_texts¶

Gets the login_texts of this Setting. Login text in different locales

SCIM++ Properties:

idcsCompositeKey: [locale]
multiValued: true
mutability: readWrite
required: false
returned: default
type: complex

Returns:	The login_texts of this Setting.
Return type:	list[oci.identity_domains.models.SettingsLoginTexts]

max_no_of_app_cmva_to_return¶

Gets the max_no_of_app_cmva_to_return of this Setting. Limit the maximum return of CMVA for an App

Added In: 2111112015

SCIM++ Properties:

idcsMinValue: 0
multiValued: false
mutability: readWrite
required: false
returned: default
type: integer
uniqueness: none

Returns:	The max_no_of_app_cmva_to_return of this Setting.
Return type:	int

max_no_of_app_role_members_to_return¶

Gets the max_no_of_app_role_members_to_return of this Setting. Limit the maximum return of members for an AppRole

Added In: 2111112015

SCIM++ Properties:

idcsMinValue: 0
multiValued: false
mutability: readWrite
required: false
returned: default
type: integer
uniqueness: none

Returns:	The max_no_of_app_role_members_to_return of this Setting.
Return type:	int

meta¶

Gets the meta of this Setting.

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

migration_status¶

Gets the migration_status of this Setting. Database Migration Status

Added In: 19.2.1

SCIM++ Properties:

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

Returns:	The migration_status of this Setting.
Return type:	str

ocid¶

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

on_premises_provisioning¶

Gets the on_premises_provisioning of this Setting. On-Premises provisioning feature toggle.

Added In: 19.2.1

SCIM++ Properties:

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

Returns:	The on_premises_provisioning of this Setting.
Return type:	bool

preferred_language¶

Gets the preferred_language of this Setting. Preferred written or spoken language used for localized user interfaces

SCIM++ Properties:

caseExact: false
idcsCanonicalValueSourceFilter: attrName eq “languages” and attrValues.value eq “$(preferredLanguage)”
idcsCanonicalValueSourceResourceType: AllowedValue
multiValued: false
mutability: readWrite
required: false
returned: default
type: string
uniqueness: none

Returns:	The preferred_language of this Setting.
Return type:	str

prev_issuer¶

Gets the prev_issuer of this Setting. Previous Tenant issuer. This is an Oracle Identity Cloud Service internal attribute which is not meant to be directly modified by ID Admin. Even if the request body (Settings) contains this attribute, the actual value will be set according to the Oracle Identity Cloud Service internal logic rather than solely based on the value provided in the request payload.

Added In: 20.1.3

SCIM++ Properties:

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

Returns:	The prev_issuer of this Setting.
Return type:	str

privacy_policy_url¶

Gets the privacy_policy_url of this Setting. Privacy Policy URL

Added In: 18.2.4

SCIM++ Properties:

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

Returns:	The privacy_policy_url of this Setting.
Return type:	str

purge_configs¶

Gets the purge_configs of this Setting. Purge Configs for different Resource Types

Deprecated Since: 19.1.6

SCIM++ Properties:

idcsCompositeKey: [resourceName]
multiValued: true
mutability: readWrite
required: false
returned: default
type: complex

Returns:	The purge_configs of this Setting.
Return type:	list[oci.identity_domains.models.SettingsPurgeConfigs]

re_auth_factor¶

Gets the re_auth_factor of this Setting. If reAuthWhenChangingMyAuthenticationFactors is true (default), this attribute specifies which re-authentication factor to use. Allowed value is “password”.

Added In: 20.1.3

SCIM++ Properties:

multiValued: true
mutability: readWrite
required: false
returned: default
type: string

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

Returns:	The re_auth_factor of this Setting.
Return type:	list[str]

re_auth_when_changing_my_authentication_factors¶

Gets the re_auth_when_changing_my_authentication_factors of this Setting. Specifies whether re-authentication is required or not when a user changes one of their security factors such as password or email. Default is true to ensure more secure behavior.

Added In: 20.1.3

SCIM++ Properties:

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

Returns:	The re_auth_when_changing_my_authentication_factors of this Setting.
Return type:	bool

schemas¶

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

service_admin_cannot_list_other_users¶

Gets the service_admin_cannot_list_other_users of this Setting. By default, a service admin can list all users in stripe. If true, a service admin cannot list other users.

Added In: 2108190438

SCIM++ Properties:

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

Returns:	The service_admin_cannot_list_other_users of this Setting.
Return type:	bool

signing_cert_public_access¶

Gets the signing_cert_public_access of this Setting. Indicates if access on SigningCert is allowed to public or not

Added In: 17.3.4

SCIM++ Properties:

multiValued: false
mutability: readWrite
required: false
returned: default
type: boolean

Returns:	The signing_cert_public_access of this Setting.
Return type:	bool

sub_mapping_attr¶

Gets the sub_mapping_attr of this Setting. Added In: 20.1.3

SCIM++ Properties: - caseExact: false - multiValued: false - mutability: readWrite - required: false - returned: default - type: string - uniqueness: none Subject mapping user profile attribute. The input format should be SCIM compliant. This attribute should be of type String and multivalued to false.

Returns:	The sub_mapping_attr of this Setting.
Return type:	str

tags¶

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

tenancy_ocid¶

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

tenant_custom_claims¶

Gets the tenant_custom_claims of this Setting. Custom claims associated with the specific tenant

Added In: 18.4.2

SCIM++ Properties:

idcsCompositeKey: [name]
multiValued: true
mutability: readWrite
required: false
returned: default
type: complex
uniqueness: none

Returns:	The tenant_custom_claims of this Setting.
Return type:	list[oci.identity_domains.models.SettingsTenantCustomClaims]

terms_of_use_url¶

Gets the terms_of_use_url of this Setting. Terms of Use URL

Added In: 18.2.4

SCIM++ Properties:

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

Returns:	The terms_of_use_url of this Setting.
Return type:	str

timezone¶

Gets the timezone of this Setting. User’s timezone

SCIM++ Properties:

caseExact: false
idcsCanonicalValueSourceFilter: attrName eq “timezones” and attrValues.value eq “$(timezone)”
idcsCanonicalValueSourceResourceType: AllowedValue
multiValued: false
mutability: readWrite
required: false
returned: default
type: string
uniqueness: none

Returns:	The timezone of this Setting.
Return type:	str