Type Alias Connector

Type declaration

• CONNECTOR_TYPE: string

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

• createConnector:function

  • createConnector(
        connectorId: string,
        connectorData: ConnectorSkeleton,
    ): Promise<ConnectorSkeleton>

    Create connector

    Parameters

    • connectorId: string

      id/name of the connector without the type prefix
    • connectorData: ConnectorSkeleton

      connector object

    Returns Promise<ConnectorSkeleton>

    a promise that resolves to an connector object

• createConnectorExportTemplate:function

  • createConnectorExportTemplate(): ConnectorExportInterface

    Create an empty connector export template

    Returns ConnectorExportInterface

    an empty connector export template

• deleteConnector:function

  • deleteConnector(connectorId: string): Promise<ConnectorSkeleton>

    Delete connector

    Parameters

    • connectorId: string

      id/name of the connector without the type prefix

    Returns Promise<ConnectorSkeleton>

    a promise that resolves an connector object

• deleteConnectors:function

  • deleteConnectors(): Promise<ConnectorSkeleton[]>

    Delete all connectors

    Returns Promise<ConnectorSkeleton[]>

    a promise that resolves to an array of connector objects

• exportConnector:function

  • exportConnector(
        connectorId: string,
        options?: ConnectorExportOptions,
    ): Promise<ConnectorExportInterface>

    Export connector

    Parameters

    • connectorId: string

      id/name of the connector without the type prefix
    • Optionaloptions: ConnectorExportOptions

      export options

    Returns Promise<ConnectorExportInterface>

    a promise that resolves to a ConnectorExportInterface object

• exportConnectors:function

  • exportConnectors(): Promise<ConnectorExportInterface>

    Export all connectors

    Returns Promise<ConnectorExportInterface>

    a promise that resolves to a ConnectorExportInterface object

• importConnector:function

  • importConnector(
        connectorId: string,
        importData: ConnectorExportInterface,
        options?: ConnectorImportOptions,
    ): Promise<ConnectorSkeleton>

    Import connector

    Parameters

    • connectorId: string

      id/name of the connector without the type prefix
    • importData: ConnectorExportInterface

      import data
    • Optionaloptions: ConnectorImportOptions

      import options

    Returns Promise<ConnectorSkeleton>

    a promise resolving to a ConnectorSkeleton object

• importConnectors:function

  • importConnectors(
        importData: ConnectorExportInterface,
        options?: ConnectorImportOptions,
    ): Promise<ConnectorSkeleton[]>

    Import all connectors

    Parameters

    • importData: ConnectorExportInterface

      import data
    • Optionaloptions: ConnectorImportOptions

      import options

    Returns Promise<ConnectorSkeleton[]>

    a promise resolving to an array of ConnectorSkeleton objects

• importFirstConnector:function

  • importFirstConnector(
        importData: ConnectorExportInterface,
        options?: ConnectorImportOptions,
    ): Promise<ConnectorSkeleton>

    Import first connector

    Parameters

    • importData: ConnectorExportInterface

      import data
    • Optionaloptions: ConnectorImportOptions

      import options

    Returns Promise<ConnectorSkeleton>

    a promise resolving to a ConnectorSkeleton object

• readConnector:function

  • readConnector(connectorId: string): Promise<ConnectorSkeleton>

    Get connector

    Parameters

    • connectorId: string

      id/name of the connector without the type prefix

    Returns Promise<ConnectorSkeleton>

    a promise that resolves an connector object

• readConnectors:function

  • readConnectors(): Promise<ConnectorSkeleton[]>

    Get all connectors

    Returns Promise<ConnectorSkeleton[]>

    a promise that resolves to an array of connector objects

• updateConnector:function

  • updateConnector(
        connectorId: string,
        connectorData: ConnectorSkeleton,
    ): Promise<ConnectorSkeleton>

    Update or create connector

    Parameters

    • connectorId: string

      id/name of the connector without the type prefix
    • connectorData: ConnectorSkeleton

      connector object

    Returns Promise<ConnectorSkeleton>

    a promise that resolves to an connector object