Connected Systems¶

A Connected System represents an external identity store that synchronises with the JIM metaverse. Examples include LDAP directories, HR databases, and file-based data sources.

Each connected system is associated with a connector that defines how JIM communicates with the external store, and contains a connector space of imported objects, a discovered schema, and optional partition/container hierarchy.

Common Workflows¶

Setting up a new connected system:

List connector definitions to find the connector type
Create a connected system with the chosen connector
Update the connected system to configure connector settings
Import schema to discover object types and attributes
Configure object types and attributes
Configure partitions if the connector supports hierarchy
Create run profiles for import, sync, and export operations

Removing a connected system:

Preview deletion impact to understand what will be affected
Delete the connected system

The Connected System Object¶

When you retrieve a connected system, the detail response contains:

{
  "id": 1,
  "name": "Corporate LDAP",
  "description": "Primary directory for employee accounts",
  "created": "2026-01-15T09:30:00Z",
  "lastUpdated": "2026-03-20T14:12:00Z",
  "status": "Active",
  "settingValuesValid": true,
  "connector": {
    "id": 3,
    "name": "JIM LDAP Connector"
  },
  "objectTypes": [
    {
      "id": 10,
      "name": "user",
      "created": "2026-01-15T09:31:00Z",
      "selected": true,
      "removeContributedAttributesOnObsoletion": false,
      "attributeCount": 47
    }
  ],
  "objectCount": 12450,
  "pendingExportCount": 0,
  "maxExportParallelism": 4
}

Attributes¶

Field	Type	Description
`id`	integer	Unique identifier
`name`	string	Display name of the connected system
`description`	string, nullable	Optional description
`created`	datetime	UTC timestamp when the system was created
`lastUpdated`	datetime, nullable	UTC timestamp of the last modification
`status`	string	Operational status: `Active` or `Deleting`
`settingValuesValid`	boolean	Whether the connector settings have been validated. Resets to `false` when settings change.
`connector`	object	Reference to the connector definition (`id`, `name`)
`objectTypes`	array	Discovered schema object types (see Object Types)
`objectCount`	integer	Total number of objects in the connector space
`pendingExportCount`	integer	Number of exports queued for processing
`maxExportParallelism`	integer, nullable	Maximum concurrent export batches (1-16). `null` defaults to sequential.

Object Types¶

Each object type in the objectTypes array contains:

Field	Type	Description
`id`	integer	Unique identifier
`name`	string	Object type name (e.g. `user`, `group`)
`created`	datetime	UTC timestamp when discovered
`selected`	boolean	Whether this type is included in synchronisation
`removeContributedAttributesOnObsoletion`	boolean	Remove contributed attributes when a sync rule no longer applies
`attributeCount`	integer	Number of attributes in this object type

Endpoints¶

Method	Path	Description
`GET`	`/api/v1/synchronisation/connected-systems`	List connected systems
`POST`	`/api/v1/synchronisation/connected-systems`	Create a connected system
`GET`	`/api/v1/synchronisation/connected-systems/{id}`	Retrieve a connected system
`PUT`	`/api/v1/synchronisation/connected-systems/{id}`	Update a connected system
`DELETE`	`/api/v1/synchronisation/connected-systems/{id}`	Delete a connected system
`POST`	`/api/v1/synchronisation/connected-systems/{id}/import-schema`	Import schema from external store
`POST`	`/api/v1/synchronisation/connected-systems/{id}/import-hierarchy`	Import partition/container hierarchy
`GET`	`/api/v1/synchronisation/connected-systems/{id}/deletion-preview`	Preview deletion impact
`POST`	`/api/v1/synchronisation/connected-systems/{id}/clear`	Clear all objects from connector space

Schema and Configuration¶

Method	Path	Description
`GET`	`/api/v1/synchronisation/connected-systems/{id}/object-types`	List object types and attributes
`PUT`	`/api/v1/synchronisation/connected-systems/{id}/object-types/{typeId}`	Update object type settings
`PUT`	`/api/v1/synchronisation/connected-systems/{id}/object-types/{typeId}/attributes/{attrId}`	Update attribute settings
`POST`	`/api/v1/synchronisation/connected-systems/{id}/object-types/{typeId}/attributes/bulk-update`	Bulk update attribute settings

Partitions and Containers¶

Method	Path	Description
`GET`	`/api/v1/synchronisation/connected-systems/{id}/partitions`	List partitions and containers
`PUT`	`/api/v1/synchronisation/connected-systems/{id}/partitions/{partitionId}`	Update partition selection
`PUT`	`/api/v1/synchronisation/connected-systems/{id}/containers/{containerId}`	Update container selection

Connector Space¶

Method	Path	Description
`GET`	`/api/v1/synchronisation/connected-systems/{id}/connector-space/{objectId}`	Retrieve a connector space object
`GET`	`/api/v1/synchronisation/connected-systems/{id}/connector-space/{objectId}/attributes/{attrName}/values`	List object attribute values (paginated)
`GET`	`/api/v1/synchronisation/connected-systems/{id}/connector-space/unresolved-references/count`	Count unresolved reference attributes

Pending Exports¶

Method	Path	Description
`GET`	`/api/v1/synchronisation/connected-systems/{id}/pending-exports`	List pending exports
`GET`	`/api/v1/synchronisation/pending-exports/{exportId}`	Retrieve a pending export
`GET`	`/api/v1/synchronisation/pending-exports/{exportId}/attribute-changes/{attrName}/values`	List attribute changes for a pending export