SCIM2 Sync Destinations may be used to synchronize changes to a service over HTTP using the SCIMv2 protocol.
The SCIM2 Sync Destination component inherits from the Sync Destination
The following components have a direct aggregation relation from SCIM2 Sync Destinations:
The properties supported by this managed object are as follows:
| Basic Properties: | Advanced Properties: |
|---|---|
| description | None |
| server | |
| endpoint-mapping | |
| query-method | |
| update-method |
| Description | A description for this Sync Destination |
| Default Value | None |
| Allowed Values | A string |
| Multi-Valued | No |
| Required | No |
| Admin Action Required | None. Modification requires no further action |
| Description | The SCIMv2 external server to which changes should be synchronized. |
| Default Value | None |
| Allowed Values | The DN of any SCIM2 External Server. |
| Multi-Valued | No |
| Required | Yes |
| Admin Action Required | None. Modification requires no further action |
| Description | A set of mappings that define SCIMv2 endpoints and the attribute mappings that will be used to convert between the mapped LDAP and SCIMv2 representations of entries. |
| Default Value | None |
| Allowed Values | The DN of any SCIM2 Endpoint Mapping. |
| Multi-Valued | Yes |
| Required | Yes |
| Admin Action Required | None. Modification requires no further action |
| Description | Specifies the method that should be used when searching for entries in the SCIMV2 server. |
| Default Value | get |
| Allowed Values | get - Issue SCIMv2 search requests using the HTTP GET method. post - Issue SCIMv2 search requests using the HTTP POST method. |
| Multi-Valued | No |
| Required | No |
| Admin Action Required | None. Modification requires no further action |
| Description | Specifies the method that should be used when updating an existing entry in the SCIMv2 server. |
| Default Value | patch |
| Allowed Values | put - Replaces the entire entry using the HTTP PUT method. This method will be available in all SCIMv2 servers, but is less efficient and introduces potential risk of losing changes to the entry made concurrently by other clients. patch - Applies targeted updates to specific attribute values using the HTTP PATCH method. The patch method is more efficient and safer than the replace method, but it is defined as optional in the SCIMv2 specification and may not be supported by all types of servers. |
| Multi-Valued | No |
| Required | No |
| Admin Action Required | None. Modification requires no further action |
To list the configured Sync Destinations:
dsconfig list-sync-destinations
[--property {propertyName}] ...
To view the configuration for an existing Sync Destination:
dsconfig get-sync-destination-prop
--destination-name {name}
[--tab-delimited]
[--script-friendly]
[--property {propertyName}] ...
To update the configuration for an existing Sync Destination:
dsconfig set-sync-destination-prop
--destination-name {name}
(--set|--add|--remove) {propertyName}:{propertyValue}
[(--set|--add|--remove) {propertyName}:{propertyValue}] ...
To create a new SCIM2 Sync Destination:
dsconfig create-sync-destination
--destination-name {name}
--type scim2
--set server:{propertyValue}
--set endpoint-mapping:{propertyValue}
[--set {propertyName}:{propertyValue}] ...
To delete an existing Sync Destination:
dsconfig delete-sync-destination
--destination-name {name}