Note: this component is designated "advanced", which means that objects of this type are not expected to be created or altered in most environments. If you believe that such a change is necessary, you may want to contact support in order to understand the potential impact of that change.
SCIM2 Endpoint Mapping are used to define a SCIMv2 endpoint, which is the path on a SCIMv2 server that may be used to interact with objects of a given type. It is associated with a set of attribute mappings that may be used to convert between the internal mapped representation of entries created by a sync class and the representation of those entries in a SCIMv2 server.
The following components have a direct aggregation relation from SCIM2 Endpoint Mapping:
The following components have a direct aggregation relation to SCIM2 Endpoint Mapping:
The properties supported by this managed object are as follows:
| Basic Properties: | Advanced Properties: |
|---|---|
| description | sync-class-name |
| endpoint-path | |
| schema-urn | |
| attribute-mapping | |
| search-attribute-mapping |
| Description | A description for this SCIM2 Endpoint Mapping |
| Default Value | None |
| Allowed Values | A string |
| Multi-Valued | No |
| Required | No |
| Admin Action Required | None. Modification requires no further action |
| Description | The portion of the path below the SCIMv2 server's base URL that may be used to access entries of this type. |
| Default Value | None |
| Allowed Values | A string |
| Multi-Valued | No |
| Required | Yes |
| Admin Action Required | None. Modification requires no further action |
| Description | The URN of the SCIMv2 schema for the entries that are associated with this endpoint. |
| Default Value | None |
| Allowed Values | A string |
| Multi-Valued | Yes |
| Required | Yes |
| Admin Action Required | None. Modification requires no further action |
| Description | The set of attribute mappings that will be used to construct the SCIMv2 representation of an entry from a source entry mapped by a sync class, and to construct the mapped LDAP representation of an entry fetched from the SCIMv2 server. |
| Default Value | None |
| Allowed Values | The DN of any SCIM2 Attribute Mapping. |
| Multi-Valued | Yes |
| Required | Yes |
| Admin Action Required | None. Modification requires no further action |
| Description | The set of attribute mappings that will be used to search for an entry in the SCIMv2 server that corresponds to a source entry mapped by a sync class. |
| Default Value | None |
| Allowed Values | The DN of any SCIM2 Attribute Mapping. |
| Multi-Valued | Yes |
| Required | Yes |
| Admin Action Required | None. Modification requires no further action |
sync-class-name (Advanced Property)
| Description | The names of the sync classes which the endpoint is associated. Entries that are mapped by one of these sync classes will be associated with this endpoint. This property is optional if this SCIM2 Endpoint Mapping is the only one that is assigned to a SCIMv2 sync destination, in which case all operations processed by that destination will use this SCIM2 Endpoint Mapping. If a SCIMv2 sync destination is configured with multiple endpoint mappings, then each must be configured with a mutually exclusive set of sync classes. Only operations mapped by one of the named sync classes may be processed by the SCIMv2 sync destination. |
| Default Value | None |
| Allowed Values | A string |
| Multi-Valued | Yes |
| Required | No |
| Admin Action Required | None. Modification requires no further action |
To list the configured SCIM2 Endpoint Mapping:
dsconfig list-scim2-endpoint-mapping
[--property {propertyName}] ...
To view the configuration for an existing SCIM2 Endpoint Mapping:
dsconfig get-scim2-endpoint-mapping-prop
--mapping-name {name}
[--tab-delimited]
[--script-friendly]
[--property {propertyName}] ...
To update the configuration for an existing SCIM2 Endpoint Mapping:
dsconfig set-scim2-endpoint-mapping-prop
--mapping-name {name}
(--set|--add|--remove) {propertyName}:{propertyValue}
[(--set|--add|--remove) {propertyName}:{propertyValue}] ...
To create a new SCIM2 Endpoint Mapping:
dsconfig create-scim2-endpoint-mapping
--mapping-name {name}
--set endpoint-path:{propertyValue}
--set schema-urn:{propertyValue}
--set attribute-mapping:{propertyValue}
--set search-attribute-mapping:{propertyValue}
[--set {propertyName}:{propertyValue}] ...
To delete an existing SCIM2 Endpoint Mapping:
dsconfig delete-scim2-endpoint-mapping
--mapping-name {name}