Create connector
id/name of the connector without the type prefix
connector object
a promise that resolves to an connector object
Create an empty connector export template
an empty connector export template
Delete connector
id/name of the connector without the type prefix
Optionaldeep: boolean
deep delete (remove dependencies)
a promise that resolves an connector object
Delete all connectors
Optionaldeep: boolean
deep delete (remove dependencies)
a promise that resolves to an array of connector objects
Disable a connector, the way the Admin UI does it. A connector that is disabled already is left alone (changed is false). A disabled connector is not a registered system any more, so there is nothing to wait for.
id/name of the connector without the type prefix
a promise that resolves to the connector configuration after the change
Enable a connector, the way the Admin UI does it, and wait until the connector answers its connection test. A connector that is enabled already is left alone (changed is false) but is still waited for. A connector that is enabled but does not answer in time is not an error: ready is false and error holds the last answer of the test.
id/name of the connector without the type prefix
Optionaloptions: ConnectorEnableOptions
how long to wait for the connector to answer (milliseconds)
a promise that resolves to the connector configuration after the change and whether the connector answers
Export connector
id/name of the connector without the type prefix
Optionaloptions: ConnectorExportOptions
export options
a promise that resolves to a ConnectorExportInterface object
Export all connectors
a promise that resolves to a ConnectorExportInterface object
Import connector
id/name of the connector without the type prefix
import data
Optionaloptions: ConnectorImportOptions
import options
a promise resolving to a ConnectorSkeleton object
Import all connectors. Every connector is tried: a connector that cannot be imported does not stop the others.
import data
Optionaloptions: ConnectorImportOptions
import options
OptionalresultCallback: ResultCallback<ConnectorSkeleton>
Optional callback to process individual results. When given, the outcome of every connector is passed to it as it happens (a failed connector as an error that names it, with the cause nested) and a failed connector does not throw: the connectors that could be imported are returned. Without it, the failures are collected and thrown as one error after every connector was tried.
a promise resolving to an array of ConnectorSkeleton objects
Import first connector
import data
Optionaloptions: ConnectorImportOptions
import options
a promise resolving to a ConnectorSkeleton object
Check if a connector is enabled. A configuration without an enabled flag counts as enabled, as it does in IDM.
id/name of the connector without the type prefix
a promise that resolves to true if the connector is enabled, false if it is disabled
Get connector
id/name of the connector without the type prefix
a promise that resolves an connector object
Read whether each connector is enabled, in one request
a promise that resolves to an object that maps the id/name of each connector (without the type prefix) to whether it is enabled
Get all connectors with ids starting with provisioner.openicf/,
excluding non-connector configurations such as the connector info provider.
a promise that resolves to an array of connector objects
Update or create connector
id/name of the connector without the type prefix
connector object
a promise that resolves to an connector object
Connector type key used to build the IDM id: '/'