Frodo Library - v5.0.0-47
    Preparing search index...

    Type Alias Connector

    type Connector = {
        CONNECTOR_TYPE: string;
        createConnector(
            connectorId: string,
            connectorData: ConnectorSkeleton,
        ): Promise<ConnectorSkeleton>;
        createConnectorExportTemplate(): ConnectorExportInterface;
        deleteConnector(
            connectorId: string,
            deep?: boolean,
        ): Promise<ConnectorSkeleton>;
        deleteConnectors(deep?: boolean): Promise<ConnectorSkeleton[]>;
        disableConnector(connectorId: string): Promise<ConnectorStateResult>;
        enableConnector(
            connectorId: string,
            options?: ConnectorEnableOptions,
        ): Promise<ConnectorStateResult>;
        exportConnector(
            connectorId: string,
            options?: ConnectorExportOptions,
        ): Promise<ConnectorExportInterface>;
        exportConnectors(): Promise<ConnectorExportInterface>;
        importConnector(
            connectorId: string,
            importData: ConnectorExportInterface,
            options?: ConnectorImportOptions,
        ): Promise<ConnectorSkeleton>;
        importConnectors(
            importData: ConnectorExportInterface,
            options?: ConnectorImportOptions,
            resultCallback?: ResultCallback<ConnectorSkeleton>,
        ): Promise<ConnectorSkeleton[]>;
        importFirstConnector(
            importData: ConnectorExportInterface,
            options?: ConnectorImportOptions,
        ): Promise<ConnectorSkeleton>;
        isConnectorEnabled(connectorId: string): Promise<boolean>;
        readConnector(connectorId: string): Promise<ConnectorSkeleton>;
        readConnectorEnabledStates(): Promise<Record<string, boolean>>;
        readConnectors(): Promise<ConnectorSkeleton[]>;
        updateConnector(
            connectorId: string,
            connectorData: ConnectorSkeleton,
        ): Promise<ConnectorSkeleton>;
    }
    Index
    CONNECTOR_TYPE: string

    Connector type key used to build the IDM id: '/'

    • Delete connector

      Parameters

      • connectorId: string

        id/name of the connector without the type prefix

      • Optionaldeep: boolean

        deep delete (remove dependencies)

      Returns Promise<ConnectorSkeleton>

      a promise that resolves an connector object

    • 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.

      Parameters

      • connectorId: string

        id/name of the connector without the type prefix

      Returns Promise<ConnectorStateResult>

      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.

      Parameters

      • connectorId: string

        id/name of the connector without the type prefix

      • Optionaloptions: ConnectorEnableOptions

        how long to wait for the connector to answer (milliseconds)

      Returns Promise<ConnectorStateResult>

      a promise that resolves to the connector configuration after the change and whether the connector answers

    • Check if a connector is enabled. A configuration without an enabled flag counts as enabled, as it does in IDM.

      Parameters

      • connectorId: string

        id/name of the connector without the type prefix

      Returns Promise<boolean>

      a promise that resolves to true if the connector is enabled, false if it is disabled

    • Read whether each connector is enabled, in one request

      Returns Promise<Record<string, boolean>>

      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.

      Returns Promise<ConnectorSkeleton[]>

      a promise that resolves to an array of connector objects