Synchronization Service

You can interact with the synchronization service over REST, as shown in the following table:

URIHTTP OperationDescription
/openidm/sync?_action=getLinkedResources&resourceName=resourcePOSTProvides a list of linked resources for the specified resource.
/openidm/sync/mappings?_queryFilter=trueGET Returns a list of all configured mappings, in the order in which they will be processed.
/openidm/sync/queue?_queryFilter=filterGET Lists the queued synchronization events, based on the specified filter.
/openidm/sync/queue/eventIDDELETE Deletes a queued synchronization event, based on its ID.

For example:

curl \
--header "X-OpenIDM-Username: openidm-admin" \
--header "X-OpenIDM-Password: openidm-admin" \
--header "Accept-API-Version: resource=1.0" \
--header "Content-Type: application/json" \
--request POST \

    "resourceName": "system/ldap/account/03496258-1c5e-40a0-8744-badc2500f262",
    "content": {
      "uid": "joe.smith1",
      "mail": "",
      "sn": "Smith",
      "givenName": "Joe",
      "employeeType": [],
      "dn": "uid=joe.smith1,ou=People,dc=example,dc=com",
      "ldapGroups": [],
      "cn": "Joe Smith",
      "kbaInfo": [],
      "aliasList": [],
      "objectClass": [
      "_id": "03496258-1c5e-40a0-8744-badc2500f262"
    "linkQualifier": "default",
    "linkType": "systemLdapAccounts_managedUser"
Read a different version of :