Frodo Library - v4.0.0-10
    Preparing search index...

    Type Alias IdmSystem

    type IdmSystem = {
        authenticateSystemObject(
            systemName: string,
            systemObjectType: string,
            username: string,
            password: string,
        ): Promise<IdObjectSkeletonInterface>;
        createSystemObject(
            systemName: string,
            systemObjectType: string,
            systemObjectData: IdObjectSkeletonInterface,
        ): Promise<IdObjectSkeletonInterface>;
        deleteSystemObject(
            systemName: string,
            systemObjectType: string,
            systemObjectId: string,
        ): Promise<IdObjectSkeletonInterface>;
        queryAllSystemObjectIds(
            systemName: string,
            systemObjectType: string,
            pageSize?: number,
            pageCookie?: string,
        ): Promise<PagedResult<IdObjectSkeletonInterface>>;
        querySystemObjects(
            systemName: string,
            systemObjectType: string,
            filter: string,
            fields?: string[],
            pageSize?: number,
            pageCookie?: string,
        ): Promise<PagedResult<IdObjectSkeletonInterface>>;
        readAvailableSystems(): Promise<SystemStatusInterface[]>;
        readSystemObject(
            systemName: string,
            systemObjectType: string,
            systemObjectId: string,
            fields?: string[],
        ): Promise<IdObjectSkeletonInterface>;
        readSystemSchema(
            systemName: string,
        ): Promise<Record<string, ObjectTypeSkeleton>>;
        readSystemStatus(systemName: string): Promise<SystemStatusInterface>;
        runSystemScript(systemName: string, scriptName: string): Promise<any>;
        testConnectorServers(): Promise<ConnectorServerStatusInterface[]>;
        updateSystemObject(
            systemName: string,
            systemObjectType: string,
            systemObjectId: string,
            systemObjectData: IdObjectSkeletonInterface,
            failIfExists?: boolean,
        ): Promise<IdObjectSkeletonInterface>;
        updateSystemObjectProperties(
            systemName: string,
            systemObjectType: string,
            systemObjectId: string,
            operations: SystemObjectPatchOperationInterface[],
        ): Promise<IdObjectSkeletonInterface>;
    }
    Index

    Methods

    authenticateSystemObject createSystemObject deleteSystemObject queryAllSystemObjectIds querySystemObjects readAvailableSystems readSystemObject readSystemSchema readSystemStatus runSystemScript testConnectorServers updateSystemObject updateSystemObjectProperties

    Methods

    • Authenticate a system object using username and password (pass-through authentication)

      Parameters

      • systemName: string

        name of system/connector

      • systemObjectType: string

        type of system object

      • username: string

        system object username

      • password: string

        system object password

      Returns Promise<IdObjectSkeletonInterface>

      a promise resolving to an IdObjectSkeletonInterface object containing only the _id

    • Delete system object

      Parameters

      • systemName: string

        name of system/connector

      • systemObjectType: string

        type of system object

      • systemObjectId: string

        id of system object

      Returns Promise<IdObjectSkeletonInterface>

      a promise resolving to an IdObjectSkeletonInterface object

    • Query all system object ids

      Parameters

      • systemName: string

        name of system/connector

      • systemObjectType: string

        type of system object

      • OptionalpageSize: number

        page size (default value: 1000)

      • OptionalpageCookie: string

        paged results cookie

      Returns Promise<PagedResult<IdObjectSkeletonInterface>>

      a promise resolving to an array of IdObjectSkeletonInterface objects

    • Query system objects using a search filter

      Parameters

      • systemName: string

        name of system/connector

      • systemObjectType: string

        type of system object

      • filter: string

        search filter

      • Optionalfields: string[]

        array of fields to return

      • OptionalpageSize: number

        page size (default value: 1000)

      • OptionalpageCookie: string

        paged results cookie

      Returns Promise<PagedResult<IdObjectSkeletonInterface>>

      a promise resolving to an array of IdObjectSkeletonInterface objects

    • Read system object

      Parameters

      • systemName: string

        name of system/connector

      • systemObjectType: string

        type of system object

      • systemObjectId: string

        id of system object

      • Optionalfields: string[]

        array of fields to return (default: ['*'])

      Returns Promise<IdObjectSkeletonInterface>

      a promise resolving to an IdObjectSkeletonInterface object

    • Read system schema

      Parameters

      • systemName: string

        name of system/connector

      Returns Promise<Record<string, ObjectTypeSkeleton>>

      a promise resolving to a map of Record<string, ObjectTypeSkeleton>

    • Run system script

      Parameters

      • systemName: string

        name of system/connector

      • scriptName: string

        name of script

      Returns Promise<any>

      a promise resolving to a status object

    • Update or create system object

      Parameters

      • systemName: string

        name of system/connector

      • systemObjectType: string

        type of system object

      • systemObjectId: string

        id of system object

      • systemObjectData: IdObjectSkeletonInterface

        system object data

      • OptionalfailIfExists: boolean

        fail if object exists (default value: false)

      Returns Promise<IdObjectSkeletonInterface>

      a promise resolving to an IdObjectSkeletonInterface object

    Settings

    Member Visibility

    On This Page

    Methods