SchemaSubAttributes

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

Bases: object

A list specifying the contained attributes

Attributes:

IDCSUI_WIDGET_CHECKBOX

A constant which can be used with the idcsui_widget property of a SchemaSubAttributes.

IDCSUI_WIDGET_COMBOBOX

A constant which can be used with the idcsui_widget property of a SchemaSubAttributes.

IDCSUI_WIDGET_INPUTTEXT

A constant which can be used with the idcsui_widget property of a SchemaSubAttributes.

IDCSUI_WIDGET_TEXTAREA

A constant which can be used with the idcsui_widget property of a SchemaSubAttributes.

IDCS_SENSITIVE_CHECKSUM

A constant which can be used with the idcs_sensitive property of a SchemaSubAttributes.

IDCS_SENSITIVE_ENCRYPT

A constant which can be used with the idcs_sensitive property of a SchemaSubAttributes.

IDCS_SENSITIVE_HASH

A constant which can be used with the idcs_sensitive property of a SchemaSubAttributes.

IDCS_SENSITIVE_HASH_SC

A constant which can be used with the idcs_sensitive property of a SchemaSubAttributes.

IDCS_SENSITIVE_NONE

A constant which can be used with the idcs_sensitive property of a SchemaSubAttributes.

MUTABILITY_IMMUTABLE

A constant which can be used with the mutability property of a SchemaSubAttributes.

MUTABILITY_READ_ONLY

A constant which can be used with the mutability property of a SchemaSubAttributes.

MUTABILITY_READ_WRITE

A constant which can be used with the mutability property of a SchemaSubAttributes.

MUTABILITY_WRITE_ONLY

A constant which can be used with the mutability property of a SchemaSubAttributes.

RETURNED_ALWAYS

A constant which can be used with the returned property of a SchemaSubAttributes.

RETURNED_DEFAULT

A constant which can be used with the returned property of a SchemaSubAttributes.

RETURNED_NEVER

A constant which can be used with the returned property of a SchemaSubAttributes.

RETURNED_REQUEST

A constant which can be used with the returned property of a SchemaSubAttributes.

TYPE_BINARY

A constant which can be used with the type property of a SchemaSubAttributes.

TYPE_BOOLEAN

A constant which can be used with the type property of a SchemaSubAttributes.

TYPE_COMPLEX

A constant which can be used with the type property of a SchemaSubAttributes.

TYPE_DATE_TIME

A constant which can be used with the type property of a SchemaSubAttributes.

TYPE_DECIMAL

A constant which can be used with the type property of a SchemaSubAttributes.

TYPE_INTEGER

A constant which can be used with the type property of a SchemaSubAttributes.

TYPE_REFERENCE

A constant which can be used with the type property of a SchemaSubAttributes.

TYPE_STRING

A constant which can be used with the type property of a SchemaSubAttributes.

UNIQUENESS_GLOBAL

A constant which can be used with the uniqueness property of a SchemaSubAttributes.

UNIQUENESS_NONE

A constant which can be used with the uniqueness property of a SchemaSubAttributes.

UNIQUENESS_SERVER

A constant which can be used with the uniqueness property of a SchemaSubAttributes.

canonical_values

Gets the canonical_values of this SchemaSubAttributes.

case_exact

Gets the case_exact of this SchemaSubAttributes.

description

Gets the description of this SchemaSubAttributes.

idcs_added_since_release_number

Gets the idcs_added_since_release_number of this SchemaSubAttributes.

idcs_added_since_version

Gets the idcs_added_since_version of this SchemaSubAttributes.

idcs_attribute_cacheable

Gets the idcs_attribute_cacheable of this SchemaSubAttributes.

idcs_attribute_mappable

Gets the idcs_attribute_mappable of this SchemaSubAttributes.

idcs_auditable

Gets the idcs_auditable of this SchemaSubAttributes.

idcs_canonical_value_source_display_attr_name

Gets the idcs_canonical_value_source_display_attr_name of this SchemaSubAttributes.

idcs_canonical_value_source_filter

Gets the idcs_canonical_value_source_filter of this SchemaSubAttributes.

idcs_canonical_value_source_key_attr_name

Gets the idcs_canonical_value_source_key_attr_name of this SchemaSubAttributes.

idcs_canonical_value_source_resource_type

Gets the idcs_canonical_value_source_resource_type of this SchemaSubAttributes.

idcs_canonical_value_source_resource_type_id

Gets the idcs_canonical_value_source_resource_type_id of this SchemaSubAttributes.

idcs_csv_attribute_name

Gets the idcs_csv_attribute_name of this SchemaSubAttributes.

idcs_default_value

Gets the idcs_default_value of this SchemaSubAttributes.

idcs_deprecated_since_release_number

Gets the idcs_deprecated_since_release_number of this SchemaSubAttributes.

idcs_deprecated_since_version

Gets the idcs_deprecated_since_version of this SchemaSubAttributes.

idcs_display_name

Gets the idcs_display_name of this SchemaSubAttributes.

idcs_display_name_message_id

Gets the idcs_display_name_message_id of this SchemaSubAttributes.

idcs_exclude_from_upgrade_patch

Gets the idcs_exclude_from_upgrade_patch of this SchemaSubAttributes.

idcs_from_target_mapper

Gets the idcs_from_target_mapper of this SchemaSubAttributes.

idcs_generated

Gets the idcs_generated of this SchemaSubAttributes.

idcs_indirect_ref_resource_attributes

Gets the idcs_indirect_ref_resource_attributes of this SchemaSubAttributes.

idcs_internal

Gets the idcs_internal of this SchemaSubAttributes.

idcs_max_length

Gets the idcs_max_length of this SchemaSubAttributes.

idcs_max_value

Gets the idcs_max_value of this SchemaSubAttributes.

idcs_max_values_returned

Gets the idcs_max_values_returned of this SchemaSubAttributes.

idcs_min_length

Gets the idcs_min_length of this SchemaSubAttributes.

idcs_min_value

Gets the idcs_min_value of this SchemaSubAttributes.

idcs_one_value_must_be_true

Gets the idcs_one_value_must_be_true of this SchemaSubAttributes.

idcs_only_one_value_can_be_true

Gets the idcs_only_one_value_can_be_true of this SchemaSubAttributes.

idcs_pii

Gets the idcs_pii of this SchemaSubAttributes.

idcs_ref_resource_attributes

Gets the idcs_ref_resource_attributes of this SchemaSubAttributes.

idcs_requires_immediate_read_after_write_for_access_flows

Gets the idcs_requires_immediate_read_after_write_for_access_flows of this SchemaSubAttributes.

idcs_requires_write_for_access_flows

Gets the idcs_requires_write_for_access_flows of this SchemaSubAttributes.

idcs_return_empty_when_null

Gets the idcs_return_empty_when_null of this SchemaSubAttributes.

idcs_rtsa_hide_attribute

Gets the idcs_rtsa_hide_attribute of this SchemaSubAttributes.

idcs_sanitize

Gets the idcs_sanitize of this SchemaSubAttributes.

idcs_scim_compliant

Gets the idcs_scim_compliant of this SchemaSubAttributes.

idcs_searchable

Gets the idcs_searchable of this SchemaSubAttributes.

idcs_sensitive

Gets the idcs_sensitive of this SchemaSubAttributes.

idcs_target_attribute_name

Gets the idcs_target_attribute_name of this SchemaSubAttributes.

idcs_target_attribute_name_to_migrate_from

Gets the idcs_target_attribute_name_to_migrate_from of this SchemaSubAttributes.

idcs_target_norm_attribute_name

Gets the idcs_target_norm_attribute_name of this SchemaSubAttributes.

idcs_target_unique_constraint_name

Gets the idcs_target_unique_constraint_name of this SchemaSubAttributes.

idcs_to_target_mapper

Gets the idcs_to_target_mapper of this SchemaSubAttributes.

idcs_trim_string_value

Gets the idcs_trim_string_value of this SchemaSubAttributes.

idcs_validate_reference

Gets the idcs_validate_reference of this SchemaSubAttributes.

idcs_value_persisted

Gets the idcs_value_persisted of this SchemaSubAttributes.

idcs_value_persisted_in_other_attribute

Gets the idcs_value_persisted_in_other_attribute of this SchemaSubAttributes.

idcsui_order

Gets the idcsui_order of this SchemaSubAttributes.

idcsui_regexp

Gets the idcsui_regexp of this SchemaSubAttributes.

idcsui_visible

Gets the idcsui_visible of this SchemaSubAttributes.

idcsui_widget

Gets the idcsui_widget of this SchemaSubAttributes.

multi_valued

Gets the multi_valued of this SchemaSubAttributes.

mutability

Gets the mutability of this SchemaSubAttributes.

name

Gets the name of this SchemaSubAttributes.

reference_types

Gets the reference_types of this SchemaSubAttributes.

required

Gets the required of this SchemaSubAttributes.

returned

Gets the returned of this SchemaSubAttributes.

type

Gets the type of this SchemaSubAttributes.

uniqueness

Gets the uniqueness of this SchemaSubAttributes.

Methods:

__init__(**kwargs)

Initializes a new SchemaSubAttributes object with values from keyword arguments.

IDCSUI_WIDGET_CHECKBOX = 'checkbox'

A constant which can be used with the idcsui_widget property of a SchemaSubAttributes. This constant has a value of “checkbox”

IDCSUI_WIDGET_COMBOBOX = 'combobox'

A constant which can be used with the idcsui_widget property of a SchemaSubAttributes. This constant has a value of “combobox”

IDCSUI_WIDGET_INPUTTEXT = 'inputtext'

A constant which can be used with the idcsui_widget property of a SchemaSubAttributes. This constant has a value of “inputtext”

IDCSUI_WIDGET_TEXTAREA = 'textarea'

A constant which can be used with the idcsui_widget property of a SchemaSubAttributes. This constant has a value of “textarea”

IDCS_SENSITIVE_CHECKSUM = 'checksum'

A constant which can be used with the idcs_sensitive property of a SchemaSubAttributes. This constant has a value of “checksum”

IDCS_SENSITIVE_ENCRYPT = 'encrypt'

A constant which can be used with the idcs_sensitive property of a SchemaSubAttributes. This constant has a value of “encrypt”

IDCS_SENSITIVE_HASH = 'hash'

A constant which can be used with the idcs_sensitive property of a SchemaSubAttributes. This constant has a value of “hash”

IDCS_SENSITIVE_HASH_SC = 'hash_sc'

A constant which can be used with the idcs_sensitive property of a SchemaSubAttributes. This constant has a value of “hash_sc”

IDCS_SENSITIVE_NONE = 'none'

A constant which can be used with the idcs_sensitive property of a SchemaSubAttributes. This constant has a value of “none”

MUTABILITY_IMMUTABLE = 'immutable'

A constant which can be used with the mutability property of a SchemaSubAttributes. This constant has a value of “immutable”

MUTABILITY_READ_ONLY = 'readOnly'

A constant which can be used with the mutability property of a SchemaSubAttributes. This constant has a value of “readOnly”

MUTABILITY_READ_WRITE = 'readWrite'

A constant which can be used with the mutability property of a SchemaSubAttributes. This constant has a value of “readWrite”

MUTABILITY_WRITE_ONLY = 'writeOnly'

A constant which can be used with the mutability property of a SchemaSubAttributes. This constant has a value of “writeOnly”

RETURNED_ALWAYS = 'always'

A constant which can be used with the returned property of a SchemaSubAttributes. This constant has a value of “always”

RETURNED_DEFAULT = 'default'

A constant which can be used with the returned property of a SchemaSubAttributes. This constant has a value of “default”

RETURNED_NEVER = 'never'

A constant which can be used with the returned property of a SchemaSubAttributes. This constant has a value of “never”

RETURNED_REQUEST = 'request'

A constant which can be used with the returned property of a SchemaSubAttributes. This constant has a value of “request”

TYPE_BINARY = 'binary'

A constant which can be used with the type property of a SchemaSubAttributes. This constant has a value of “binary”

TYPE_BOOLEAN = 'boolean'

A constant which can be used with the type property of a SchemaSubAttributes. This constant has a value of “boolean”

TYPE_COMPLEX = 'complex'

A constant which can be used with the type property of a SchemaSubAttributes. This constant has a value of “complex”

TYPE_DATE_TIME = 'dateTime'

A constant which can be used with the type property of a SchemaSubAttributes. This constant has a value of “dateTime”

TYPE_DECIMAL = 'decimal'

A constant which can be used with the type property of a SchemaSubAttributes. This constant has a value of “decimal”

TYPE_INTEGER = 'integer'

A constant which can be used with the type property of a SchemaSubAttributes. This constant has a value of “integer”

TYPE_REFERENCE = 'reference'

A constant which can be used with the type property of a SchemaSubAttributes. This constant has a value of “reference”

TYPE_STRING = 'string'

A constant which can be used with the type property of a SchemaSubAttributes. This constant has a value of “string”

UNIQUENESS_GLOBAL = 'global'

A constant which can be used with the uniqueness property of a SchemaSubAttributes. This constant has a value of “global”

UNIQUENESS_NONE = 'none'

A constant which can be used with the uniqueness property of a SchemaSubAttributes. This constant has a value of “none”

UNIQUENESS_SERVER = 'server'

A constant which can be used with the uniqueness property of a SchemaSubAttributes. This constant has a value of “server”

__init__(**kwargs)

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

Parameters
  • name (str) – The value to assign to the name property of this SchemaSubAttributes.

  • idcs_requires_immediate_read_after_write_for_access_flows (bool) – The value to assign to the idcs_requires_immediate_read_after_write_for_access_flows property of this SchemaSubAttributes.

  • idcs_requires_write_for_access_flows (bool) – The value to assign to the idcs_requires_write_for_access_flows property of this SchemaSubAttributes.

  • idcs_display_name_message_id (str) – The value to assign to the idcs_display_name_message_id property of this SchemaSubAttributes.

  • idcs_rtsa_hide_attribute (bool) – The value to assign to the idcs_rtsa_hide_attribute property of this SchemaSubAttributes.

  • idcs_internal (bool) – The value to assign to the idcs_internal property of this SchemaSubAttributes.

  • type (str) – The value to assign to the type property of this SchemaSubAttributes. Allowed values for this property are: “string”, “complex”, “boolean”, “decimal”, “integer”, “dateTime”, “reference”, “binary”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

  • multi_valued (bool) – The value to assign to the multi_valued property of this SchemaSubAttributes.

  • description (str) – The value to assign to the description property of this SchemaSubAttributes.

  • required (bool) – The value to assign to the required property of this SchemaSubAttributes.

  • idcs_return_empty_when_null (bool) – The value to assign to the idcs_return_empty_when_null property of this SchemaSubAttributes.

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

  • idcs_default_value (str) – The value to assign to the idcs_default_value property of this SchemaSubAttributes.

  • case_exact (bool) – The value to assign to the case_exact property of this SchemaSubAttributes.

  • mutability (str) – The value to assign to the mutability property of this SchemaSubAttributes. Allowed values for this property are: “readOnly”, “readWrite”, “immutable”, “writeOnly”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

  • returned (str) – The value to assign to the returned property of this SchemaSubAttributes. Allowed values for this property are: “always”, “never”, “default”, “request”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

  • idcs_csv_attribute_name (str) – The value to assign to the idcs_csv_attribute_name property of this SchemaSubAttributes.

  • uniqueness (str) – The value to assign to the uniqueness property of this SchemaSubAttributes. Allowed values for this property are: “none”, “server”, “global”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

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

  • idcs_deprecated_since_version (int) – The value to assign to the idcs_deprecated_since_version property of this SchemaSubAttributes.

  • idcs_added_since_version (int) – The value to assign to the idcs_added_since_version property of this SchemaSubAttributes.

  • idcs_deprecated_since_release_number (str) – The value to assign to the idcs_deprecated_since_release_number property of this SchemaSubAttributes.

  • idcs_added_since_release_number (str) – The value to assign to the idcs_added_since_release_number property of this SchemaSubAttributes.

  • idcs_min_length (int) – The value to assign to the idcs_min_length property of this SchemaSubAttributes.

  • idcs_max_length (int) – The value to assign to the idcs_max_length property of this SchemaSubAttributes.

  • idcs_min_value (int) – The value to assign to the idcs_min_value property of this SchemaSubAttributes.

  • idcs_max_value (int) – The value to assign to the idcs_max_value property of this SchemaSubAttributes.

  • idcs_only_one_value_can_be_true (bool) – The value to assign to the idcs_only_one_value_can_be_true property of this SchemaSubAttributes.

  • idcs_max_values_returned (int) – The value to assign to the idcs_max_values_returned property of this SchemaSubAttributes.

  • idcs_one_value_must_be_true (bool) – The value to assign to the idcs_one_value_must_be_true property of this SchemaSubAttributes.

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

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

  • idcs_value_persisted (bool) – The value to assign to the idcs_value_persisted property of this SchemaSubAttributes.

  • idcs_sensitive (str) – The value to assign to the idcs_sensitive property of this SchemaSubAttributes. Allowed values for this property are: “encrypt”, “hash”, “hash_sc”, “checksum”, “none”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

  • idcs_trim_string_value (bool) – The value to assign to the idcs_trim_string_value property of this SchemaSubAttributes.

  • idcs_searchable (bool) – The value to assign to the idcs_searchable property of this SchemaSubAttributes.

  • idcs_generated (bool) – The value to assign to the idcs_generated property of this SchemaSubAttributes.

  • idcs_auditable (bool) – The value to assign to the idcs_auditable property of this SchemaSubAttributes.

  • idcs_target_attribute_name (str) – The value to assign to the idcs_target_attribute_name property of this SchemaSubAttributes.

  • idcs_target_norm_attribute_name (str) – The value to assign to the idcs_target_norm_attribute_name property of this SchemaSubAttributes.

  • idcs_target_attribute_name_to_migrate_from (str) – The value to assign to the idcs_target_attribute_name_to_migrate_from property of this SchemaSubAttributes.

  • idcs_target_unique_constraint_name (str) – The value to assign to the idcs_target_unique_constraint_name property of this SchemaSubAttributes.

  • idcs_to_target_mapper (str) – The value to assign to the idcs_to_target_mapper property of this SchemaSubAttributes.

  • idcs_from_target_mapper (str) – The value to assign to the idcs_from_target_mapper property of this SchemaSubAttributes.

  • idcs_display_name (str) – The value to assign to the idcs_display_name property of this SchemaSubAttributes.

  • idcs_canonical_value_source_resource_type (str) – The value to assign to the idcs_canonical_value_source_resource_type property of this SchemaSubAttributes.

  • idcs_canonical_value_source_filter (str) – The value to assign to the idcs_canonical_value_source_filter property of this SchemaSubAttributes.

  • idcs_canonical_value_source_resource_type_id (str) – The value to assign to the idcs_canonical_value_source_resource_type_id property of this SchemaSubAttributes.

  • idcs_canonical_value_source_display_attr_name (str) – The value to assign to the idcs_canonical_value_source_display_attr_name property of this SchemaSubAttributes.

  • idcs_canonical_value_source_key_attr_name (str) – The value to assign to the idcs_canonical_value_source_key_attr_name property of this SchemaSubAttributes.

  • idcs_validate_reference (bool) – The value to assign to the idcs_validate_reference property of this SchemaSubAttributes.

  • idcs_scim_compliant (bool) – The value to assign to the idcs_scim_compliant property of this SchemaSubAttributes.

  • idcs_attribute_mappable (bool) – The value to assign to the idcs_attribute_mappable property of this SchemaSubAttributes.

  • idcs_attribute_cacheable (bool) – The value to assign to the idcs_attribute_cacheable property of this SchemaSubAttributes.

  • idcsui_order (int) – The value to assign to the idcsui_order property of this SchemaSubAttributes.

  • idcsui_regexp (str) – The value to assign to the idcsui_regexp property of this SchemaSubAttributes.

  • idcsui_visible (bool) – The value to assign to the idcsui_visible property of this SchemaSubAttributes.

  • idcsui_widget (str) – The value to assign to the idcsui_widget property of this SchemaSubAttributes. Allowed values for this property are: “inputtext”, “checkbox”, “textarea”, “combobox”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

  • idcs_value_persisted_in_other_attribute (bool) – The value to assign to the idcs_value_persisted_in_other_attribute property of this SchemaSubAttributes.

  • idcs_pii (bool) – The value to assign to the idcs_pii property of this SchemaSubAttributes.

  • idcs_sanitize (bool) – The value to assign to the idcs_sanitize property of this SchemaSubAttributes.

  • idcs_exclude_from_upgrade_patch (bool) – The value to assign to the idcs_exclude_from_upgrade_patch property of this SchemaSubAttributes.

property canonical_values

Gets the canonical_values of this SchemaSubAttributes. A collection of canonical values. Applicable Service Providers MUST specify the canonical types specified in the core schema specification–for example, “work”, “home”.

SCIM++ Properties:
  • caseExact: true

  • multiValued: true

  • mutability: readWrite

  • required: false

  • returned: default

  • type: string

  • uniqueness: none

Returns

The canonical_values of this SchemaSubAttributes.

Return type

list[str]

property case_exact

Gets the case_exact of this SchemaSubAttributes. Specifies if the String attribute is case-sensitive

SCIM++ Properties:
  • multiValued: false

  • mutability: readWrite

  • required: false

  • returned: default

  • type: boolean

Returns

The case_exact of this SchemaSubAttributes.

Return type

bool

property description

Gets the description of this SchemaSubAttributes. Attribute’s human-readable description

SCIM++ Properties:
  • caseExact: true

  • multiValued: false

  • mutability: readWrite

  • required: false

  • returned: default

  • type: string

  • uniqueness: none

Returns

The description of this SchemaSubAttributes.

Return type

str

property idcs_added_since_release_number

Gets the idcs_added_since_release_number of this SchemaSubAttributes. Indicates that the schema has been added since this release number

Added In: 17.3.4

SCIM++ Properties:
  • multiValued: false

  • mutability: readWrite

  • required: false

  • returned: default

  • type: string

Returns

The idcs_added_since_release_number of this SchemaSubAttributes.

Return type

str

property idcs_added_since_version

Gets the idcs_added_since_version of this SchemaSubAttributes. Indicates that the schema has been added since version

Deprecated Since: 19.3.3

SCIM++ Properties:
  • multiValued: false

  • mutability: readWrite

  • required: false

  • returned: default

  • type: integer

Returns

The idcs_added_since_version of this SchemaSubAttributes.

Return type

int

property idcs_attribute_cacheable

Gets the idcs_attribute_cacheable of this SchemaSubAttributes. Specifies whether the attribute is cacheable. True by default for all attributes. If attribute with idcsAttributeCachable = false, is present “attributesToGet” while executing GET/SEARCH on cacheable resource, Cache is missed and data is fetched from Data Provider.

Added In: 17.3.4

SCIM++ Properties:
  • multiValued: false

  • mutability: readWrite

  • required: false

  • returned: default

  • type: boolean

Returns

The idcs_attribute_cacheable of this SchemaSubAttributes.

Return type

bool

property idcs_attribute_mappable

Gets the idcs_attribute_mappable of this SchemaSubAttributes. Specifies if the attribute can be used for mapping with external identity sources such as AD or LDAP. If isSchemaMappable: false for the schema in which this attribute is defined, then this flag is ignored.

SCIM++ Properties:
  • multiValued: false

  • mutability: readOnly

  • required: false

  • returned: default

  • type: boolean

Returns

The idcs_attribute_mappable of this SchemaSubAttributes.

Return type

bool

property idcs_auditable

Gets the idcs_auditable of this SchemaSubAttributes. Specifies whether changes to this attribute value will be audited

SCIM++ Properties:
  • multiValued: false

  • mutability: readWrite

  • required: false

  • returned: default

  • type: boolean

Returns

The idcs_auditable of this SchemaSubAttributes.

Return type

bool

property idcs_canonical_value_source_display_attr_name

Gets the idcs_canonical_value_source_display_attr_name of this SchemaSubAttributes. Display name for the canonical value attribute name.

Added In: 17.4.4

SCIM++ Properties:
  • caseExact: false

  • idcsSearchable: false

  • multiValued: false

  • mutability: readWrite

  • required: false

  • returned: default

  • type: string

  • uniqueness: none

Returns

The idcs_canonical_value_source_display_attr_name of this SchemaSubAttributes.

Return type

str

property idcs_canonical_value_source_filter

Gets the idcs_canonical_value_source_filter of this SchemaSubAttributes. Filter to use when getting canonical values for this schema attribute

SCIM++ Properties:
  • caseExact: false

  • idcsSearchable: false

  • multiValued: false

  • mutability: readWrite

  • required: false

  • returned: default

  • type: string

  • uniqueness: none

Returns

The idcs_canonical_value_source_filter of this SchemaSubAttributes.

Return type

str

property idcs_canonical_value_source_key_attr_name

Gets the idcs_canonical_value_source_key_attr_name of this SchemaSubAttributes. Source key attribute for the canonical value.

Added In: 17.4.4

SCIM++ Properties:
  • caseExact: true

  • multiValued: false

  • mutability: readWrite

  • required: false

  • returned: default

  • type: string

  • uniqueness: none

Returns

The idcs_canonical_value_source_key_attr_name of this SchemaSubAttributes.

Return type

str

property idcs_canonical_value_source_resource_type

Gets the idcs_canonical_value_source_resource_type of this SchemaSubAttributes. Specifies the Resource type to read from for dynamic canonical values

SCIM++ Properties:
  • caseExact: true

  • multiValued: false

  • mutability: readWrite

  • required: false

  • returned: default

  • type: string

  • uniqueness: none

Returns

The idcs_canonical_value_source_resource_type of this SchemaSubAttributes.

Return type

str

property idcs_canonical_value_source_resource_type_id

Gets the idcs_canonical_value_source_resource_type_id of this SchemaSubAttributes. Specifies the Resource type ID to read from for dynamic canonical values

Added In: 17.4.4

SCIM++ Properties:
  • caseExact: true

  • multiValued: false

  • mutability: readWrite

  • required: false

  • returned: default

  • type: string

  • uniqueness: none

Returns

The idcs_canonical_value_source_resource_type_id of this SchemaSubAttributes.

Return type

str

property idcs_csv_attribute_name

Gets the idcs_csv_attribute_name of this SchemaSubAttributes. The attribute that defines the CSV header name for import/export

SCIM++ Properties:
  • caseExact: true

  • multiValued: false

  • mutability: readWrite

  • required: false

  • returned: default

  • type: string

  • uniqueness: none

Returns

The idcs_csv_attribute_name of this SchemaSubAttributes.

Return type

str

property idcs_default_value

Gets the idcs_default_value of this SchemaSubAttributes. Specifies the default value for an attribute. The value must be one from canonicalValues if defined.

Added In: 18.1.6

SCIM++ Properties:
  • caseExact: true

  • multiValued: false

  • mutability: readWrite

  • required: false

  • returned: default

  • type: string

  • uniqueness: none

Returns

The idcs_default_value of this SchemaSubAttributes.

Return type

str

property idcs_deprecated_since_release_number

Gets the idcs_deprecated_since_release_number of this SchemaSubAttributes. Indicates that the schema has been deprecated since this release number

Added In: 17.3.4

SCIM++ Properties:
  • multiValued: false

  • mutability: readWrite

  • required: false

  • returned: default

  • type: string

Returns

The idcs_deprecated_since_release_number of this SchemaSubAttributes.

Return type

str

property idcs_deprecated_since_version

Gets the idcs_deprecated_since_version of this SchemaSubAttributes. Indicates that the schema has been deprecated since version

Deprecated Since: 19.3.3

SCIM++ Properties:
  • multiValued: false

  • mutability: readWrite

  • required: false

  • returned: default

  • type: integer

Returns

The idcs_deprecated_since_version of this SchemaSubAttributes.

Return type

int

property idcs_display_name

Gets the idcs_display_name of this SchemaSubAttributes. Specifies the user-friendly displayable attribute name or catalog key used for localization

SCIM++ Properties:
  • caseExact: true

  • multiValued: false

  • mutability: readWrite

  • required: false

  • returned: default

  • type: string

  • uniqueness: none

Returns

The idcs_display_name of this SchemaSubAttributes.

Return type

str

property idcs_display_name_message_id

Gets the idcs_display_name_message_id of this SchemaSubAttributes. Localized schema attribute display name for use by UI client for displaying attribute labels

SCIM++ Properties:
  • caseExact: false

  • multiValued: false

  • mutability: readOnly

  • required: false

  • returned: default

  • type: string

  • uniqueness: none

Returns

The idcs_display_name_message_id of this SchemaSubAttributes.

Return type

str

property idcs_exclude_from_upgrade_patch

Gets the idcs_exclude_from_upgrade_patch of this SchemaSubAttributes. Specifies whether the attribute should be excluded from the BulkApi patch generated by gradle task for upgrading OOTB resources.

Added In: 2104150946

SCIM++ Properties:
  • multiValued: false

  • mutability: readWrite

  • required: false

  • returned: never

  • type: boolean

Returns

The idcs_exclude_from_upgrade_patch of this SchemaSubAttributes.

Return type

bool

property idcs_from_target_mapper

Gets the idcs_from_target_mapper of this SchemaSubAttributes. Specifies the mapper to use when mapping this attribute value from DataProvider-specific semantics

SCIM++ Properties:
  • caseExact: true

  • multiValued: false

  • mutability: readWrite

  • required: false

  • returned: default

  • type: string

  • uniqueness: none

Returns

The idcs_from_target_mapper of this SchemaSubAttributes.

Return type

str

property idcs_generated

Gets the idcs_generated of this SchemaSubAttributes. Specifies whether this attribute value was generated

SCIM++ Properties:
  • multiValued: false

  • mutability: readWrite

  • required: false

  • returned: default

  • type: boolean

Returns

The idcs_generated of this SchemaSubAttributes.

Return type

bool

property idcs_indirect_ref_resource_attributes

Gets the idcs_indirect_ref_resource_attributes of this SchemaSubAttributes. Specifies the indirectly referenced Resources

SCIM++ Properties:
  • multiValued: true

  • mutability: readWrite

  • required: false

  • returned: default

  • type: string

Returns

The idcs_indirect_ref_resource_attributes of this SchemaSubAttributes.

Return type

list[str]

property idcs_internal

Gets the idcs_internal of this SchemaSubAttributes. Specifies whether the schema attribute is for internal use only. Internal attributes are not exposed via REST. This attribute overrides mutability for create/update if the request is internal and the attribute internal flag is set to True. This attribute overrides the return attribute while building SCIM response attributes when both the request is internal and the schema attribute is internal.

SCIM++ Properties:
  • multiValued: false

  • mutability: readWrite

  • required: false

  • returned: default

  • type: boolean

Returns

The idcs_internal of this SchemaSubAttributes.

Return type

bool

property idcs_max_length

Gets the idcs_max_length of this SchemaSubAttributes. Specifies the maximum length of this attribute

SCIM++ Properties:
  • multiValued: false

  • mutability: readWrite

  • required: false

  • returned: default

  • type: integer

Returns

The idcs_max_length of this SchemaSubAttributes.

Return type

int

property idcs_max_value

Gets the idcs_max_value of this SchemaSubAttributes. Specifies the maximum value of the integer attribute

SCIM++ Properties:
  • multiValued: false

  • mutability: readOnly

  • required: false

  • returned: default

  • type: integer

Returns

The idcs_max_value of this SchemaSubAttributes.

Return type

int

property idcs_max_values_returned

Gets the idcs_max_values_returned of this SchemaSubAttributes. SCIM++ Properties: - caseExact: true - multiValued: false - mutability: readOnly - required: false - returned: default - type: integer - uniqueness: none Specify a limit on the number of attribute-values that any caller will receive when requesting a CMVA attribute. If the no of CMVA instances exceeds the limit then Oracle Identity Cloud Service will throw exception. Users can choose to refine the filter on CMVA attribute.

Returns

The idcs_max_values_returned of this SchemaSubAttributes.

Return type

int

property idcs_min_length

Gets the idcs_min_length of this SchemaSubAttributes. Specifies the minimum length of this attribute

SCIM++ Properties:
  • multiValued: false

  • mutability: readWrite

  • required: false

  • returned: default

  • type: integer

Returns

The idcs_min_length of this SchemaSubAttributes.

Return type

int

property idcs_min_value

Gets the idcs_min_value of this SchemaSubAttributes. Specifies the minimum value of the integer attribute

SCIM++ Properties:
  • multiValued: false

  • mutability: readOnly

  • required: false

  • returned: default

  • type: integer

Returns

The idcs_min_value of this SchemaSubAttributes.

Return type

int

property idcs_one_value_must_be_true

Gets the idcs_one_value_must_be_true of this SchemaSubAttributes. If true, ARM will ensure atleast one of the instances of CMVA has the attribute value set to true.

SCIM++ Properties:
  • caseExact: true

  • multiValued: false

  • mutability: readOnly

  • required: false

  • returned: default

  • type: boolean

  • uniqueness: none

Returns

The idcs_one_value_must_be_true of this SchemaSubAttributes.

Return type

bool

property idcs_only_one_value_can_be_true

Gets the idcs_only_one_value_can_be_true of this SchemaSubAttributes. If true, specifies that the sub attribute value can be set to true on one and only one instance of the CMVA.

SCIM++ Properties:
  • caseExact: true

  • multiValued: false

  • mutability: readOnly

  • required: false

  • returned: default

  • type: boolean

  • uniqueness: none

Returns

The idcs_only_one_value_can_be_true of this SchemaSubAttributes.

Return type

bool

property idcs_pii

Gets the idcs_pii of this SchemaSubAttributes. Specifies whether the attribute is PII (personal information). False by default for all attributes. If attribute with idcsPii = true, it’s value must be obfuscated before it’s written to the Oracle Identity Cloud Service system logs.

Added In: 18.3.6

SCIM++ Properties:
  • multiValued: false

  • mutability: readOnly

  • required: false

  • returned: default

  • type: boolean

Returns

The idcs_pii of this SchemaSubAttributes.

Return type

bool

property idcs_ref_resource_attributes

Gets the idcs_ref_resource_attributes of this SchemaSubAttributes. Specifies the directly referenced Resources

SCIM++ Properties:
  • multiValued: true

  • mutability: readWrite

  • required: false

  • returned: default

  • type: string

Returns

The idcs_ref_resource_attributes of this SchemaSubAttributes.

Return type

list[str]

property idcs_requires_immediate_read_after_write_for_access_flows

Gets the idcs_requires_immediate_read_after_write_for_access_flows of this SchemaSubAttributes. If true, indicates that the attribute value must be written to the home region and requires immediate read-after-write consistency for access flows initiated from a replica region.

Added In: 2209220956

SCIM++ Properties:
  • multiValued: false

  • mutability: readWrite

  • required: false

  • returned: never

  • type: boolean

Returns

The idcs_requires_immediate_read_after_write_for_access_flows of this SchemaSubAttributes.

Return type

bool

property idcs_requires_write_for_access_flows

Gets the idcs_requires_write_for_access_flows of this SchemaSubAttributes. If true, indicates that the attribute value must be written to the home region for access flows initiated from a replica region.

Added In: 2205120021

SCIM++ Properties:
  • multiValued: false

  • mutability: readWrite

  • required: false

  • returned: default

  • type: boolean

  • uniqueness: none

Returns

The idcs_requires_write_for_access_flows of this SchemaSubAttributes.

Return type

bool

property idcs_return_empty_when_null

Gets the idcs_return_empty_when_null of this SchemaSubAttributes. Specifies if the attribute is required

Added In: 2305190132

SCIM++ Properties:
  • multiValued: false

  • mutability: readWrite

  • required: false

  • returned: default

  • type: boolean

Returns

The idcs_return_empty_when_null of this SchemaSubAttributes.

Return type

bool

property idcs_rtsa_hide_attribute

Gets the idcs_rtsa_hide_attribute of this SchemaSubAttributes. Specifies if the attributes in this schema can be displayed externally

Added In: 19.1.4

SCIM++ Properties:
  • caseExact: false

  • multiValued: false

  • mutability: readOnly

  • required: false

  • returned: default

  • type: boolean

  • uniqueness: none

Returns

The idcs_rtsa_hide_attribute of this SchemaSubAttributes.

Return type

bool

property idcs_sanitize

Gets the idcs_sanitize of this SchemaSubAttributes. Specifies if the value of the attribute should be sanitized using OWASP library for HTML content

Added In: 20.1.3

SCIM++ Properties:
  • caseExact: true

  • multiValued: false

  • mutability: readWrite

  • required: false

  • returned: default

  • type: boolean

  • uniqueness: none

Returns

The idcs_sanitize of this SchemaSubAttributes.

Return type

bool

property idcs_scim_compliant

Gets the idcs_scim_compliant of this SchemaSubAttributes. Indicates if the attribute is scim compliant, default is true

SCIM++ Properties:
  • multiValued: false

  • mutability: readOnly

  • required: false

  • returned: default

  • type: boolean

Returns

The idcs_scim_compliant of this SchemaSubAttributes.

Return type

bool

property idcs_searchable

Gets the idcs_searchable of this SchemaSubAttributes. Specifies whether this attribute can be included in a search filter

SCIM++ Properties:
  • multiValued: false

  • mutability: readWrite

  • required: false

  • returned: default

  • type: boolean

Returns

The idcs_searchable of this SchemaSubAttributes.

Return type

bool

property idcs_sensitive

Gets the idcs_sensitive of this SchemaSubAttributes. Specifiees if the attribute should be encrypted or hashed

SCIM++ Properties:
  • caseExact: true

  • multiValued: false

  • mutability: readWrite

  • required: false

  • returned: default

  • type: string

  • uniqueness: none

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

Returns

The idcs_sensitive of this SchemaSubAttributes.

Return type

str

property idcs_target_attribute_name

Gets the idcs_target_attribute_name of this SchemaSubAttributes. Target attribute name that this attribute gets mapped to for persistence

SCIM++ Properties:
  • caseExact: true

  • multiValued: false

  • mutability: readWrite

  • required: false

  • returned: default

  • type: string

  • uniqueness: none

Returns

The idcs_target_attribute_name of this SchemaSubAttributes.

Return type

str

property idcs_target_attribute_name_to_migrate_from

Gets the idcs_target_attribute_name_to_migrate_from of this SchemaSubAttributes. Old Target attribute name from child table for CSVA attribute prior to migration. This maintains this attribute used to get mapped to for persistence

Added In: 19.2.1

SCIM++ Properties:
  • caseExact: true

  • multiValued: false

  • mutability: readWrite

  • required: false

  • returned: default

  • type: string

  • uniqueness: none

Returns

The idcs_target_attribute_name_to_migrate_from of this SchemaSubAttributes.

Return type

str

property idcs_target_norm_attribute_name

Gets the idcs_target_norm_attribute_name of this SchemaSubAttributes. Target normalized attribute name that this normalized value of attribute gets mapped to for persistence. Only set for caseExact=false & searchable attributes. Do not use by default.

Added In: 19.1.4

SCIM++ Properties:
  • caseExact: true

  • multiValued: false

  • mutability: readWrite

  • required: false

  • returned: default

  • type: string

  • uniqueness: none

Returns

The idcs_target_norm_attribute_name of this SchemaSubAttributes.

Return type

str

property idcs_target_unique_constraint_name

Gets the idcs_target_unique_constraint_name of this SchemaSubAttributes. Target index name created for this attribute for performance

SCIM++ Properties:
  • caseExact: true

  • multiValued: false

  • mutability: readOnly

  • required: false

  • returned: default

  • type: string

  • uniqueness: none

Returns

The idcs_target_unique_constraint_name of this SchemaSubAttributes.

Return type

str

property idcs_to_target_mapper

Gets the idcs_to_target_mapper of this SchemaSubAttributes. Specifies the mapper to use when mapping this attribute value to DataProvider-specific semantics

SCIM++ Properties:
  • caseExact: true

  • multiValued: false

  • mutability: readWrite

  • required: false

  • returned: default

  • type: string

  • uniqueness: none

Returns

The idcs_to_target_mapper of this SchemaSubAttributes.

Return type

str

property idcs_trim_string_value

Gets the idcs_trim_string_value of this SchemaSubAttributes. Trims any leading and trailing blanks from String values. Default is True.

SCIM++ Properties:
  • multiValued: false

  • mutability: readOnly

  • required: false

  • returned: default

  • type: boolean

Returns

The idcs_trim_string_value of this SchemaSubAttributes.

Return type

bool

property idcs_validate_reference

Gets the idcs_validate_reference of this SchemaSubAttributes. Validate payload reference value during create, replace, and update. Default is True.

SCIM++ Properties:
  • caseExact: false

  • idcsSearchable: false

  • multiValued: false

  • mutability: readWrite

  • required: false

  • returned: default

  • type: boolean

  • uniqueness: none

Returns

The idcs_validate_reference of this SchemaSubAttributes.

Return type

bool

property idcs_value_persisted

Gets the idcs_value_persisted of this SchemaSubAttributes. Specifies whether the sub-attribute of the Resource attribute is persisted

SCIM++ Properties:
  • multiValued: false

  • mutability: readWrite

  • required: false

  • returned: default

  • type: boolean

Returns

The idcs_value_persisted of this SchemaSubAttributes.

Return type

bool

property idcs_value_persisted_in_other_attribute

Gets the idcs_value_persisted_in_other_attribute of this SchemaSubAttributes. If true, ARM should not validate the value of the attribute since it will be converted/migrated to another attribute internally by the manager which will build valid post, put, or patch payload, depending on the client requested operation

Added In: 18.2.2

SCIM++ Properties:
  • multiValued: false

  • mutability: readWrite

  • required: false

  • returned: default

  • type: boolean

Returns

The idcs_value_persisted_in_other_attribute of this SchemaSubAttributes.

Return type

bool

property idcsui_order

Gets the idcsui_order of this SchemaSubAttributes. Metadata used by Oracle Identity Cloud Service UI to sequence the attributes displayed on the Account Form.

Added In: 17.4.2

SCIM++ Properties:
  • multiValued: false

  • mutability: readWrite

  • required: false

  • returned: default

  • type: integer

Returns

The idcsui_order of this SchemaSubAttributes.

Return type

int

property idcsui_regexp

Gets the idcsui_regexp of this SchemaSubAttributes. Metadata used by Oracle Identity Cloud Service UI to validate the attribute values using regular expressions.

Added In: 17.4.2

SCIM++ Properties:
  • multiValued: false

  • mutability: readWrite

  • required: false

  • returned: default

  • type: string

Returns

The idcsui_regexp of this SchemaSubAttributes.

Return type

str

property idcsui_visible

Gets the idcsui_visible of this SchemaSubAttributes. Metadata used by Oracle Identity Cloud Service UI to decide whether the attribute must be displayed on the Account Form.

Added In: 17.4.2

SCIM++ Properties:
  • multiValued: false

  • mutability: readWrite

  • required: false

  • returned: default

  • type: boolean

Returns

The idcsui_visible of this SchemaSubAttributes.

Return type

bool

property idcsui_widget

Gets the idcsui_widget of this SchemaSubAttributes. Metadata used by Oracle Identity Cloud Service UI to render a widget for this attribute on the Account Form.

Added In: 17.4.2

SCIM++ Properties:
  • multiValued: false

  • mutability: readWrite

  • required: false

  • returned: default

  • type: string

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

Returns

The idcsui_widget of this SchemaSubAttributes.

Return type

str

property multi_valued

Gets the multi_valued of this SchemaSubAttributes. Indicates the attribute’s plurality

SCIM++ Properties:
  • multiValued: false

  • mutability: readWrite

  • required: false

  • returned: default

  • type: boolean

Returns

The multi_valued of this SchemaSubAttributes.

Return type

bool

property mutability

Gets the mutability of this SchemaSubAttributes. Specifies if the attribute is mutable

SCIM++ Properties:
  • caseExact: true

  • multiValued: false

  • mutability: readWrite

  • required: false

  • returned: default

  • type: string

  • uniqueness: none

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

Returns

The mutability of this SchemaSubAttributes.

Return type

str

property name

Gets the name of this SchemaSubAttributes. Attribute’s name

SCIM++ Properties:
  • caseExact: true

  • multiValued: false

  • mutability: readWrite

  • required: false

  • returned: default

  • type: string

  • uniqueness: none

Returns

The name of this SchemaSubAttributes.

Return type

str

property reference_types

Gets the reference_types of this SchemaSubAttributes. The names of the Resource types that may be referenced–for example, User. This is only applicable for attributes that are of the “reference” data type.

SCIM++ Properties:
  • caseExact: true

  • multiValued: true

  • mutability: readWrite

  • required: false

  • returned: default

  • type: string

  • uniqueness: none

Returns

The reference_types of this SchemaSubAttributes.

Return type

list[str]

property required

Gets the required of this SchemaSubAttributes. Specifies if the attribute is required

SCIM++ Properties:
  • multiValued: false

  • mutability: readWrite

  • required: false

  • returned: default

  • type: boolean

Returns

The required of this SchemaSubAttributes.

Return type

bool

property returned

Gets the returned of this SchemaSubAttributes. A single keyword that indicates when an attribute and associated values are returned in response to a GET request or in response to a PUT, POST, or PATCH request

SCIM++ Properties:
  • caseExact: true

  • multiValued: false

  • mutability: readWrite

  • required: false

  • returned: default

  • type: string

  • uniqueness: none

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

Returns

The returned of this SchemaSubAttributes.

Return type

str

property type

Gets the type of this SchemaSubAttributes. Attribute’s data type–for example, String

SCIM++ Properties:
  • caseExact: false

  • multiValued: false

  • mutability: readWrite

  • required: false

  • returned: default

  • type: string

  • uniqueness: none

Allowed values for this property are: “string”, “complex”, “boolean”, “decimal”, “integer”, “dateTime”, “reference”, “binary”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns

The type of this SchemaSubAttributes.

Return type

str

property uniqueness

Gets the uniqueness of this SchemaSubAttributes. A single keyword value that specifies how the Service Provider enforces uniqueness of attribute values. A server MAY reject an invalid value based on uniqueness by returning an HTTP response code of 400 (Bad Request). A client MAY enforce uniqueness on the client side to a greater degree than the Service Provider enforces. For example, a client could make a value unique while the server has a uniqueness of “none”.

SCIM++ Properties:
  • caseExact: true

  • multiValued: false

  • mutability: readWrite

  • required: false

  • returned: default

  • type: string

  • uniqueness: none

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

Returns

The uniqueness of this SchemaSubAttributes.

Return type

str