Schema¶

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

Bases: object

SCIM schema

Methods

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

Attributes

`attributes`	Gets the attributes of this Schema.
`description`	Gets the description of this Schema.
`external_id`	Gets the external_id of this Schema.
`idcs_attribute_cacheable`	Gets the idcs_attribute_cacheable of this Schema.
`idcs_mappable`	[Required] Gets the idcs_mappable of this Schema.
`idcs_maps_to_same_target_attribute_name_as`	Gets the idcs_maps_to_same_target_attribute_name_as of this Schema.
`idcs_override_common_attribute`	Gets the idcs_override_common_attribute of this Schema.
`idcs_resource_types`	Gets the idcs_resource_types of this Schema.
`name`	Gets the name of this Schema.
`schemas`	[Required] Gets the schemas of this Schema.

__init__(**kwargs)¶

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

Parameters:

schemas (list[str]) – The value to assign to the schemas property of this Schema.
idcs_maps_to_same_target_attribute_name_as (str) – The value to assign to the idcs_maps_to_same_target_attribute_name_as property of this Schema.
external_id (str) – The value to assign to the external_id property of this Schema.
name (str) – The value to assign to the name property of this Schema.
idcs_resource_types (list[str]) – The value to assign to the idcs_resource_types property of this Schema.
description (str) – The value to assign to the description property of this Schema.
idcs_mappable (bool) – The value to assign to the idcs_mappable property of this Schema.
idcs_attribute_cacheable (bool) – The value to assign to the idcs_attribute_cacheable property of this Schema.
idcs_override_common_attribute (bool) – The value to assign to the idcs_override_common_attribute property of this Schema.
attributes (list[oci.identity_domains.models.SchemaAttributes]) – The value to assign to the attributes property of this Schema.

attributes¶

Gets the attributes of this Schema. A complex type that specifies the set of Resource attributes

SCIM++ Properties:

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

Returns:	The attributes of this Schema.
Return type:	list[oci.identity_domains.models.SchemaAttributes]

description¶

Gets the description of this Schema. Schema’s human-readable description

SCIM++ Properties:

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

Returns:	The description of this Schema.
Return type:	str

external_id¶

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

idcs_attribute_cacheable¶

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

idcs_mappable¶

[Required] Gets the idcs_mappable of this Schema. Specifies if the attributes in this schema can be used for mapping with external identity sources such as AD or LDAP

SCIM++ Properties:

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

Returns:	The idcs_mappable of this Schema.
Return type:	bool

idcs_maps_to_same_target_attribute_name_as¶

Gets the idcs_maps_to_same_target_attribute_name_as of this Schema. Contains the canonical name of the other attribute sharing the same idcsTargetAttributeName

Added In: 2209122038

SCIM++ Properties:

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

Returns:	The idcs_maps_to_same_target_attribute_name_as of this Schema.
Return type:	str

idcs_override_common_attribute¶

Gets the idcs_override_common_attribute of this Schema. Specifies whether the dataprovider mapping from resource schema should override from common schema with the same name.

Added In: 2102181953

SCIM++ Properties:

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

Returns:	The idcs_override_common_attribute of this Schema.
Return type:	bool

idcs_resource_types¶

Gets the idcs_resource_types of this Schema. Resource types defs this resource refers to

SCIM++ Properties:

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

Returns:	The idcs_resource_types of this Schema.
Return type:	list[str]

name¶

Gets the name of this Schema. Schema’s human-readable name

SCIM++ Properties:

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

Returns:	The name of this Schema.
Return type:	str

schemas¶

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