Type Alias PolicySet

Type declaration

• createPolicySet:function

  • createPolicySet(
        policySetData: PolicySetSkeleton,
        policySetName?: string,
    ): Promise<PolicySetSkeleton>

    Parameters

    • policySetData: PolicySetSkeleton
    • OptionalpolicySetName: string

    Returns Promise<PolicySetSkeleton>

• createPolicySetExportTemplate:function

  • createPolicySetExportTemplate(): PolicySetExportInterface

    Create policy export template

    Returns PolicySetExportInterface

    policy export interface

• deletePolicySet:function

  • deletePolicySet(policySetName: string): Promise<PolicySetSkeleton>

    Parameters

    • policySetName: string

    Returns Promise<PolicySetSkeleton>

• exportPolicySet:function

  • exportPolicySet(
        policySetName: string,
        options?: PolicySetExportOptions,
    ): Promise<PolicySetExportInterface>

    Export policy set

    Parameters

    • policySetName: string

      policy set name
    • Optionaloptions: PolicySetExportOptions

      export options

    Returns Promise<PolicySetExportInterface>

    a promise that resolves to an PolicySetExportInterface object

• exportPolicySets:function

  • exportPolicySets(
        options?: PolicySetExportOptions,
    ): Promise<PolicySetExportInterface>

    Export policy sets

    Parameters

    • Optionaloptions: PolicySetExportOptions

      export options

    Returns Promise<PolicySetExportInterface>

    a promise that resolves to an PolicySetExportInterface object

• getPolicySet:function

  • getPolicySet(policySetName: string): Promise<PolicySetSkeleton>

    Get policy set

    Parameters

    • policySetName: string

      policy set name

    Returns Promise<PolicySetSkeleton>

    a promise that resolves to a policy set object

    Deprecated

    since v2.0.0 use Policy.readPolicySet | readPolicySet instead

    readPolicySet(policySetName: string): Promise<PolicySetSkeleton>
    Copy

• getPolicySets:function

  • getPolicySets(): Promise<PolicySetSkeleton[]>

    Get all policy sets

    Returns Promise<PolicySetSkeleton[]>

    a promise that resolves to an array of policy set objects

    Deprecated

    since v2.0.0 use Policy.readPolicySets | readPolicySets instead

    readPolicySets(): Promise<PolicySetSkeleton[]>
    Copy

• importFirstPolicySet:function

  • importFirstPolicySet(
        importData: PolicySetExportInterface,
        options?: PolicySetImportOptions,
    ): Promise<any>

    Import first policy set

    Parameters

    • importData: PolicySetExportInterface

      import data
    • Optionaloptions: PolicySetImportOptions

      import options

    Returns Promise<any>

• importPolicySet:function

  • importPolicySet(
        policySetName: string,
        importData: PolicySetExportInterface,
        options?: PolicySetImportOptions,
    ): Promise<any>

    Import policy set

    Parameters

    • policySetName: string

      policy set name
    • importData: PolicySetExportInterface

      import data
    • Optionaloptions: PolicySetImportOptions

      import options

    Returns Promise<any>

• importPolicySets:function

  • importPolicySets(
        importData: PolicySetExportInterface,
        options?: PolicySetImportOptions,
    ): Promise<any[]>

    Import policy sets

    Parameters

    • importData: PolicySetExportInterface

      import data
    • Optionaloptions: PolicySetImportOptions

      import options

    Returns Promise<any[]>

    The imported policy sets

• readPolicySet:function

  • readPolicySet(policySetName: string): Promise<PolicySetSkeleton>

    Read policy set

    Parameters

    • policySetName: string

      policy set name

    Returns Promise<PolicySetSkeleton>

    a promise that resolves to a policy set object

• readPolicySets:function

  • readPolicySets(): Promise<PolicySetSkeleton[]>

    Read all policy sets

    Returns Promise<PolicySetSkeleton[]>

    a promise that resolves to an array of policy set objects

• updatePolicySet:function

  • updatePolicySet(
        policySetData: PolicySetSkeleton,
        policySetName?: string,
    ): Promise<PolicySetSkeleton>

    Parameters

    • policySetData: PolicySetSkeleton
    • OptionalpolicySetName: string

    Returns Promise<PolicySetSkeleton>