MappedAttribute¶

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

Bases: object

Schema for MappedAttribute resource.

Attributes

`DIRECTION_INBOUND`	A constant which can be used with the direction property of a MappedAttribute.
`DIRECTION_OUTBOUND`	A constant which can be used with the direction property of a MappedAttribute.
`IDCS_PREVENTED_OPERATIONS_DELETE`	A constant which can be used with the idcs_prevented_operations property of a MappedAttribute.
`IDCS_PREVENTED_OPERATIONS_REPLACE`	A constant which can be used with the idcs_prevented_operations property of a MappedAttribute.
`IDCS_PREVENTED_OPERATIONS_UPDATE`	A constant which can be used with the idcs_prevented_operations property of a MappedAttribute.
`IDCS_RESOURCE_TYPE_CONTAINER`	A constant which can be used with the idcs_resource_type property of a MappedAttribute.
`IDCS_RESOURCE_TYPE_GROUP`	A constant which can be used with the idcs_resource_type property of a MappedAttribute.
`IDCS_RESOURCE_TYPE_USER`	A constant which can be used with the idcs_resource_type property of a MappedAttribute.
`REF_RESOURCE_TYPE_ACCOUNT_OBJECT_CLASS`	A constant which can be used with the ref_resource_type property of a MappedAttribute.
`REF_RESOURCE_TYPE_APP`	A constant which can be used with the ref_resource_type property of a MappedAttribute.
`REF_RESOURCE_TYPE_IDENTITY_PROVIDER`	A constant which can be used with the ref_resource_type property of a MappedAttribute.
`REF_RESOURCE_TYPE_MANAGED_OBJECT_CLASS`	A constant which can be used with the ref_resource_type property of a MappedAttribute.
`attribute_mappings`	Gets the attribute_mappings of this MappedAttribute.
`compartment_ocid`	Gets the compartment_ocid of this MappedAttribute.
`delete_in_progress`	Gets the delete_in_progress of this MappedAttribute.
`direction`	[Required] Gets the direction of this MappedAttribute.
`domain_ocid`	Gets the domain_ocid of this MappedAttribute.
`id`	Gets the id of this MappedAttribute.
`idcs_created_by`	Gets the idcs_created_by of this MappedAttribute.
`idcs_last_modified_by`	Gets the idcs_last_modified_by of this MappedAttribute.
`idcs_last_upgraded_in_release`	Gets the idcs_last_upgraded_in_release of this MappedAttribute.
`idcs_prevented_operations`	Gets the idcs_prevented_operations of this MappedAttribute.
`idcs_resource_type`	[Required] Gets the idcs_resource_type of this MappedAttribute.
`meta`	Gets the meta of this MappedAttribute.
`ocid`	Gets the ocid of this MappedAttribute.
`ref_resource_id`	[Required] Gets the ref_resource_id of this MappedAttribute.
`ref_resource_type`	[Required] Gets the ref_resource_type of this MappedAttribute.
`schemas`	[Required] Gets the schemas of this MappedAttribute.
`tags`	Gets the tags of this MappedAttribute.
`tenancy_ocid`	Gets the tenancy_ocid of this MappedAttribute.

Methods

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

DIRECTION_INBOUND = 'inbound'¶: A constant which can be used with the direction property of a MappedAttribute. This constant has a value of “inbound”

DIRECTION_OUTBOUND = 'outbound'¶: A constant which can be used with the direction property of a MappedAttribute. This constant has a value of “outbound”

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

IDCS_RESOURCE_TYPE_CONTAINER = 'Container'¶: A constant which can be used with the idcs_resource_type property of a MappedAttribute. This constant has a value of “Container”

IDCS_RESOURCE_TYPE_GROUP = 'Group'¶: A constant which can be used with the idcs_resource_type property of a MappedAttribute. This constant has a value of “Group”

IDCS_RESOURCE_TYPE_USER = 'User'¶: A constant which can be used with the idcs_resource_type property of a MappedAttribute. This constant has a value of “User”

REF_RESOURCE_TYPE_ACCOUNT_OBJECT_CLASS = 'AccountObjectClass'¶: A constant which can be used with the ref_resource_type property of a MappedAttribute. This constant has a value of “AccountObjectClass”

REF_RESOURCE_TYPE_APP = 'App'¶: A constant which can be used with the ref_resource_type property of a MappedAttribute. This constant has a value of “App”

REF_RESOURCE_TYPE_IDENTITY_PROVIDER = 'IdentityProvider'¶: A constant which can be used with the ref_resource_type property of a MappedAttribute. This constant has a value of “IdentityProvider”

REF_RESOURCE_TYPE_MANAGED_OBJECT_CLASS = 'ManagedObjectClass'¶: A constant which can be used with the ref_resource_type property of a MappedAttribute. This constant has a value of “ManagedObjectClass”

__init__(**kwargs)¶

Initializes a new MappedAttribute 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 MappedAttribute.
ocid (str) – The value to assign to the ocid property of this MappedAttribute.
schemas (list[str]) – The value to assign to the schemas property of this MappedAttribute.
meta (oci.identity_domains.models.Meta) – The value to assign to the meta property of this MappedAttribute.
idcs_created_by (oci.identity_domains.models.IdcsCreatedBy) – The value to assign to the idcs_created_by property of this MappedAttribute.
idcs_last_modified_by (oci.identity_domains.models.IdcsLastModifiedBy) – The value to assign to the idcs_last_modified_by property of this MappedAttribute.
idcs_prevented_operations (list[str]) – The value to assign to the idcs_prevented_operations property of this MappedAttribute. 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 MappedAttribute.
delete_in_progress (bool) – The value to assign to the delete_in_progress property of this MappedAttribute.
idcs_last_upgraded_in_release (str) – The value to assign to the idcs_last_upgraded_in_release property of this MappedAttribute.
domain_ocid (str) – The value to assign to the domain_ocid property of this MappedAttribute.
compartment_ocid (str) – The value to assign to the compartment_ocid property of this MappedAttribute.
tenancy_ocid (str) – The value to assign to the tenancy_ocid property of this MappedAttribute.
idcs_resource_type (str) – The value to assign to the idcs_resource_type property of this MappedAttribute. Allowed values for this property are: “User”, “Group”, “Container”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
ref_resource_type (str) – The value to assign to the ref_resource_type property of this MappedAttribute. Allowed values for this property are: “AccountObjectClass”, “App”, “ManagedObjectClass”, “IdentityProvider”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
ref_resource_id (str) – The value to assign to the ref_resource_id property of this MappedAttribute.
direction (str) – The value to assign to the direction property of this MappedAttribute. Allowed values for this property are: “inbound”, “outbound”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
attribute_mappings (list[oci.identity_domains.models.MappedAttributeAttributeMappings]) – The value to assign to the attribute_mappings property of this MappedAttribute.

attribute_mappings¶

Gets the attribute_mappings of this MappedAttribute. A list of attribute mappings between Oracle Identity Cloud Service Resource Type and Account Object Class

SCIM++ Properties:

idcsCompositeKey: [idcsAttributeName, managedObjectAttributeName]
idcsSearchable: true
multiValued: true
mutability: readWrite
required: false
returned: default
type: complex
uniqueness: none

Returns:	The attribute_mappings of this MappedAttribute.
Return type:	list[oci.identity_domains.models.MappedAttributeAttributeMappings]

compartment_ocid¶

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

delete_in_progress¶

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

direction¶

[Required] Gets the direction of this MappedAttribute. Direction of the attribute mapping. inbound indicates mapping is from source ManagedObjectClass to Oracle Identity Cloud Service ResourceType. outbound indicates mapping is from Oracle Identity Cloud Service Resource Type to target ManagedObjectClass.

SCIM++ Properties:

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

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

Returns:	The direction of this MappedAttribute.
Return type:	str

domain_ocid¶

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

id¶

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

idcs_created_by¶

Gets the idcs_created_by of this MappedAttribute.

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

idcs_last_modified_by¶

Gets the idcs_last_modified_by of this MappedAttribute.

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

idcs_last_upgraded_in_release¶

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

idcs_prevented_operations¶

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

idcs_resource_type¶

[Required] Gets the idcs_resource_type of this MappedAttribute. The Oracle Identity Cloud Service Resource Type for which the mapping is being done

SCIM++ Properties:

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

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

Returns:	The idcs_resource_type of this MappedAttribute.
Return type:	str

meta¶

Gets the meta of this MappedAttribute.

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

ocid¶

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

ref_resource_id¶

[Required] Gets the ref_resource_id of this MappedAttribute. Soft Reference to store Resource ID that holds the mapping

Added In: 17.4.6

SCIM++ Properties:

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

Returns:	The ref_resource_id of this MappedAttribute.
Return type:	str

ref_resource_type¶

[Required] Gets the ref_resource_type of this MappedAttribute. The Reference Resource Type that holds the mapping

Added In: 17.4.2

SCIM++ Properties:

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

Allowed values for this property are: “AccountObjectClass”, “App”, “ManagedObjectClass”, “IdentityProvider”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:	The ref_resource_type of this MappedAttribute.
Return type:	str

schemas¶

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

tags¶

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

tenancy_ocid¶

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