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

    Type Alias CirclesOfTrust

    type CirclesOfTrust = {
        createCircleOfTrust(
            cotId?: string,
            cotData?: CircleOfTrustSkeleton,
        ): Promise<CircleOfTrustSkeleton>;
        createCirclesOfTrustExportTemplate(): CirclesOfTrustExportInterface;
        deleteCircleOfTrust(cotId: string): Promise<CircleOfTrustSkeleton>;
        deleteCirclesOfTrust(
            entityProviders?: string[],
        ): Promise<CircleOfTrustSkeleton[]>;
        exportCircleOfTrust(cotId: string): Promise<CirclesOfTrustExportInterface>;
        exportCirclesOfTrust(
            entityProviders?: string[],
        ): Promise<CirclesOfTrustExportInterface>;
        importCircleOfTrust(
            cotId: string,
            importData: CirclesOfTrustExportInterface,
        ): Promise<CircleOfTrustSkeleton>;
        importCirclesOfTrust(
            importData: CirclesOfTrustExportInterface,
            entityProviders?: string[],
            resultCallback?: ResultCallback<CircleOfTrustSkeleton>,
        ): Promise<CircleOfTrustSkeleton[]>;
        importFirstCircleOfTrust(
            importData: CirclesOfTrustExportInterface,
        ): Promise<CircleOfTrustSkeleton>;
        readCircleOfTrust(cotId: string): Promise<CircleOfTrustSkeleton>;
        readCirclesOfTrust(
            entityProviders?: string[],
        ): Promise<CircleOfTrustSkeleton[]>;
        updateCircleOfTrust(
            cotId: string,
            cotData: CircleOfTrustSkeleton,
        ): Promise<CircleOfTrustSkeleton>;
    }
    Index
    • Export all circles of trust. A deployment that does not offer them (PingOne Advanced Identity Cloud answers that the operation is not available) exports none and nothing is thrown; every other failure, including a credential without the scope it needs, throws.

      Parameters

      • OptionalentityProviders: string[]

        filter by entity providers

      Returns Promise<CirclesOfTrustExportInterface>

    • Import all circles of trust

      Parameters

      • importData: CirclesOfTrustExportInterface

        Import data

      • OptionalentityProviders: string[]

        filter by entity providers

      • OptionalresultCallback: ResultCallback<CircleOfTrustSkeleton>

        Optional callback to process individual results. When given, the outcome of every circle of trust that was created or updated is passed to it as it happens (a failed circle of trust as an error that names it) and a failed circle of trust does not throw: the circles of trust that could be imported are returned. A circle of trust that is filtered out or does not need updating is not reported. Without it, the failures are collected and thrown as one error after every circle of trust was tried. Failing to read the entity providers always throws.

      Returns Promise<CircleOfTrustSkeleton[]>

      a promise resolving to an array of circle of trust objects that were created or updated. Note: If a circle of trust already exists and does not need updating, it is omitted from the response array.