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

    Type Alias Service

    type Service = {
        createServiceExportTemplate(): ServiceExportInterface;
        deleteFullService(
            serviceId: string,
            globalConfig?: boolean,
        ): Promise<AmServiceSkeleton>;
        deleteFullServices(globalConfig?: boolean): Promise<AmServiceSkeleton[]>;
        exportService(
            serviceId: string,
            globalConfig?: boolean,
        ): Promise<ServiceExportInterface>;
        exportServices(
            globalConfig?: boolean,
            resultCallback?: ResultCallback<FullService>,
        ): Promise<ServiceExportInterface>;
        getFullServices(
            globalConfig?: boolean,
            resultCallback?: ResultCallback<FullService>,
        ): Promise<FullService[]>;
        getListOfServices(globalConfig?: boolean): Promise<AmServiceSkeleton[]>;
        importService(
            serviceId: string,
            importData: ServiceExportInterface,
            options: ServiceImportOptions,
        ): Promise<AmServiceSkeleton>;
        importServices(
            importData: ServiceExportInterface,
            options: ServiceImportOptions,
            resultCallback?: ResultCallback<AmServiceSkeleton>,
        ): Promise<AmServiceSkeleton[]>;
    }
    Index
    • Deletes the specified service

      Parameters

      • serviceId: string

        The service to delete

      • OptionalglobalConfig: boolean

        true if the global service is the target of the operation, false otherwise. Default: false.

      Returns Promise<AmServiceSkeleton>

    • Deletes all services

      Parameters

      • OptionalglobalConfig: boolean

        true if the global service is the target of the operation, false otherwise. Default: false.

      Returns Promise<AmServiceSkeleton[]>

      Promise resolving to an array of deleted services

      After all services are attempted, names each failed service. Successful deletes are reported, and services unavailable in PingOne Advanced Identity Cloud are skipped.

    • Export service. The response can be saved to file as is.

      Parameters

      • serviceId: string

        service id/name

      • OptionalglobalConfig: boolean

        true if the global service is the target of the operation, false otherwise. Default: false.

      Returns Promise<ServiceExportInterface>

      Promise resolving to a ServiceExportInterface object.

    • Export all services

      Parameters

      • OptionalglobalConfig: boolean

        true if the global service is the target of the operation, false otherwise. Default: false.

      • OptionalresultCallback: ResultCallback<FullService>

        Optional callback to process individual results. With a callback, a service that cannot be read is passed to it as an error that names the service and is left out of the export; without one the export fails.

      Returns Promise<ServiceExportInterface>

    • Get all services including their descendents.

      Parameters

      • OptionalglobalConfig: boolean

        true if the global service is the target of the operation, false otherwise. Default: false.

      • OptionalresultCallback: ResultCallback<FullService>

        Optional callback to process individual results. With a callback, a service that cannot be read is passed to it as an error that names the service and does not fail the read: the services that could be read are returned.

      Returns Promise<FullService[]>

      Promise resolving to an array of services with their descendants

      Without a callback, after all services are attempted, names each failed service. Services unavailable in PingOne Advanced Identity Cloud are skipped.

    • Get list of services

      Parameters

      • OptionalglobalConfig: boolean

        true if the list of global services is requested, false otherwise. Default: false.

      Returns Promise<AmServiceSkeleton[]>

    • Imports multiple services from the same file. Optionally clean (remove) existing services first

      Parameters

      • importData: ServiceExportInterface

        The service configuration export data to import

      • options: ServiceImportOptions

        Import options

      • OptionalresultCallback: ResultCallback<AmServiceSkeleton>

        Optional callback to process individual results. When given, the outcome of every service is passed to it as it happens (a failed service as an error that names it) and a failed service does not throw: the services that could be imported are returned. A service of the file that does not belong to the target (another realm, or global when importing into the realm) is not imported and not reported. Without it, the failures are collected and thrown as one error after every service was tried.

      Returns Promise<AmServiceSkeleton[]>

      A promise resolving to an array of service objects