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

    Type Alias PolicySet

    type PolicySet = {
        createPolicySet(
            policySetData: PolicySetSkeleton,
            policySetName?: string,
        ): Promise<PolicySetSkeleton>;
        createPolicySetExportTemplate(): PolicySetExportInterface;
        deletePolicySet(policySetName: string): Promise<PolicySetSkeleton>;
        exportPolicySet(
            policySetName: string,
            options?: PolicySetExportOptions,
        ): Promise<PolicySetExportInterface>;
        exportPolicySets(
            options?: PolicySetExportOptions,
        ): Promise<PolicySetExportInterface>;
        getPolicySet(policySetName: string): Promise<PolicySetSkeleton>;
        getPolicySets(): Promise<PolicySetSkeleton[]>;
        importFirstPolicySet(
            importData: PolicySetExportInterface,
            options?: PolicySetImportOptions,
        ): Promise<any>;
        importPolicySet(
            policySetName: string,
            importData: PolicySetExportInterface,
            options?: PolicySetImportOptions,
        ): Promise<any>;
        importPolicySets(
            importData: PolicySetExportInterface,
            options?: PolicySetImportOptions,
        ): Promise<any[]>;
        readPolicySet(policySetName: string): Promise<PolicySetSkeleton>;
        readPolicySets(): Promise<PolicySetSkeleton[]>;
        updatePolicySet(
            policySetData: PolicySetSkeleton,
            policySetName?: string,
        ): Promise<PolicySetSkeleton>;
    }
    Index

    Methods

    createPolicySet createPolicySetExportTemplate deletePolicySet exportPolicySet exportPolicySets importFirstPolicySet importPolicySet importPolicySets readPolicySet readPolicySets updatePolicySet

    Deprecated

    getPolicySet getPolicySets

    Methods

    Deprecated

    • Get policy set

      Parameters

      • policySetName: string

        policy set name

      Returns Promise<PolicySetSkeleton>

      a promise that resolves to a policy set object

      since v2.0.0 use Policy.readPolicySet | readPolicySet instead

      readPolicySet(policySetName: string): Promise<PolicySetSkeleton>

    • Get all policy sets

      Returns Promise<PolicySetSkeleton[]>

      a promise that resolves to an array of policy set objects

      since v2.0.0 use Policy.readPolicySets | readPolicySets instead

      readPolicySets(): Promise<PolicySetSkeleton[]>

    Settings

    Member Visibility

    On This Page

    Methods
    Deprecated