Frodo Library - v4.0.0-10
    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[]>;
        exportConnector(
            connectorId: string,
            options?: ConnectorExportOptions,
        ): Promise<ConnectorExportInterface>;
        exportConnectors(): Promise<ConnectorExportInterface>;
        importConnector(
            connectorId: string,
            importData: ConnectorExportInterface,
            options?: ConnectorImportOptions,
        ): Promise<ConnectorSkeleton>;
        importConnectors(
            importData: ConnectorExportInterface,
            options?: ConnectorImportOptions,
        ): Promise<ConnectorSkeleton[]>;
        importFirstConnector(
            importData: ConnectorExportInterface,
            options?: ConnectorImportOptions,
        ): Promise<ConnectorSkeleton>;
        readConnector(connectorId: string): Promise<ConnectorSkeleton>;
        readConnectors(): Promise<ConnectorSkeleton[]>;
        updateConnector(
            connectorId: string,
            connectorData: ConnectorSkeleton,
        ): Promise<ConnectorSkeleton>;
    }
    Index

    Properties

    CONNECTOR_TYPE

    Methods

    createConnector createConnectorExportTemplate deleteConnector deleteConnectors exportConnector exportConnectors importConnector importConnectors importFirstConnector readConnector readConnectors updateConnector

    Properties

    CONNECTOR_TYPE: string

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

    Methods

    • 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

    Settings

    Member Visibility

    On This Page

    Properties
    Methods