Type alias IdmSystem

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>;
}

Type declaration

  • authenticateSystemObject:function
    • authenticateSystemObject(systemName: string, systemObjectType: string, username: string, password: string): Promise<IdObjectSkeletonInterface>

    • 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

  • createSystemObject:function
  • deleteSystemObject:function
    • deleteSystemObject(systemName: string, systemObjectType: string, systemObjectId: string): Promise<IdObjectSkeletonInterface>

    • 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

  • queryAllSystemObjectIds:function
    • queryAllSystemObjectIds(systemName: string, systemObjectType: string, pageSize?: number, pageCookie?: string): Promise<PagedResult<IdObjectSkeletonInterface>>

    • Query all system object ids

      Parameters

      • systemName: string

        name of system/connector

      • systemObjectType: string

        type of system object

      • Optional pageSize: number

        page size (default value: 1000)

      • Optional pageCookie: string

        paged results cookie

      Returns Promise<PagedResult<IdObjectSkeletonInterface>>

      a promise resolving to an array of IdObjectSkeletonInterface objects

  • querySystemObjects:function
    • querySystemObjects(systemName: string, systemObjectType: string, filter: string, fields?: string[], pageSize?: number, pageCookie?: string): Promise<PagedResult<IdObjectSkeletonInterface>>

    • Query system objects using a search filter

      Parameters

      • systemName: string

        name of system/connector

      • systemObjectType: string

        type of system object

      • filter: string

        search filter

      • Optional fields: string[]

        array of fields to return

      • Optional pageSize: number

        page size (default value: 1000)

      • Optional pageCookie: string

        paged results cookie

      Returns Promise<PagedResult<IdObjectSkeletonInterface>>

      a promise resolving to an array of IdObjectSkeletonInterface objects

  • readAvailableSystems:function
  • readSystemObject:function
    • readSystemObject(systemName: string, systemObjectType: string, systemObjectId: string, fields?: string[]): Promise<IdObjectSkeletonInterface>

    • Read system object

      Parameters

      • systemName: string

        name of system/connector

      • systemObjectType: string

        type of system object

      • systemObjectId: string

        id of system object

      • Optional fields: string[]

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

      Returns Promise<IdObjectSkeletonInterface>

      a promise resolving to an IdObjectSkeletonInterface object

  • readSystemSchema:function
    • readSystemSchema(systemName: string): Promise<Record<string, ObjectTypeSkeleton>>

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

  • readSystemStatus:function
  • runSystemScript:function
    • runSystemScript(systemName: string, scriptName: string): Promise<any>

    • 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

  • testConnectorServers:function
  • updateSystemObject:function
    • updateSystemObject(systemName: string, systemObjectType: string, systemObjectId: string, systemObjectData: IdObjectSkeletonInterface, failIfExists?: boolean): Promise<IdObjectSkeletonInterface>

    • 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

      • Optional failIfExists: boolean

        fail if object exists (default value: false)

      Returns Promise<IdObjectSkeletonInterface>

      a promise resolving to an IdObjectSkeletonInterface object

  • updateSystemObjectProperties:function

Settings

Member Visibility

Theme