Type Alias Policy

Type declaration

• createPolicy:function

  • createPolicy(
        policyId: string,
        policyData: PolicySkeleton,
    ): Promise<PolicySkeleton>

    Update or create policy

    Parameters

    • policyId: string

      policy id/name
    • policyData: PolicySkeleton

      policy object

    Returns Promise<PolicySkeleton>

    promise resolving to a policy object

• createPolicyExportTemplate:function

  • createPolicyExportTemplate(): PolicyExportInterface

    Create policy export template

    Returns PolicyExportInterface

• deletePolicy:function

  • deletePolicy(policyId: string): Promise<any>

    Delete policy

    Parameters

    • policyId: string

      policy id/name

    Returns Promise<any>

    promise resolving to a policy object

• exportPolicies:function

  • exportPolicies(options?: PolicyExportOptions): Promise<PolicyExportInterface>

    Export policies

    Parameters

    • Optionaloptions: PolicyExportOptions

      export options

    Returns Promise<PolicyExportInterface>

    a promise that resolves to an PolicyExportInterface object

• exportPoliciesByPolicySet:function

  • exportPoliciesByPolicySet(
        policySetName: string,
        options?: PolicyExportOptions,
    ): Promise<PolicyExportInterface>

    Export policies by policy set

    Parameters

    • policySetName: string

      policy set id/name
    • Optionaloptions: PolicyExportOptions

      export options

    Returns Promise<PolicyExportInterface>

    a promise that resolves to an PolicyExportInterface object

• exportPolicy:function

  • exportPolicy(
        policyId: string,
        options?: PolicyExportOptions,
    ): Promise<PolicyExportInterface>

    Export policy

    Parameters

    • policyId: string

      policy id/name
    • Optionaloptions: PolicyExportOptions

    Returns Promise<PolicyExportInterface>

    a promise that resolves to a PolicyExportInterface object

• getPolicies:function

  • getPolicies(): Promise<PolicySkeleton[]>

    Get all policies

    Returns Promise<PolicySkeleton[]>

    a promise that resolves to an array of policy set objects

    Deprecated

    since v2.0.0 use Agent.readPolicies | readPolicies instead

    readPolicies(): Promise<PolicySkeleton[]>
    Copy

• getPoliciesByPolicySet:function

  • getPoliciesByPolicySet(policySetId: string): Promise<PolicySkeleton[]>

    Get policies by policy set

    Parameters

    • policySetId: string

      policy set id/name

    Returns Promise<PolicySkeleton[]>

    a promise resolving to an array of policy objects

    Deprecated

    since v2.0.0 use Agent.readPoliciesByPolicySet | readPoliciesByPolicySet instead

    readPoliciesByPolicySet(policySetId: string): Promise<PolicySkeleton[]>
    Copy

• getPolicy:function

  • getPolicy(policyId: string): Promise<PolicySkeleton>

    Get policy

    Parameters

    • policyId: string

      policy id/name

    Returns Promise<PolicySkeleton>

    promise resolving to a policy object

    Deprecated

    since v2.0.0 use Agent.readPolicy | readPolicy instead

    readPolicy(policyId: string): Promise<PolicySkeleton>
    Copy

• importFirstPolicy:function

  • importFirstPolicy(
        importData: PolicyExportInterface,
        options?: PolicyImportOptions,
    ): Promise<PolicySkeleton>

    Import first policy

    Parameters

    • importData: PolicyExportInterface

      import data
    • Optionaloptions: PolicyImportOptions

      import options

    Returns Promise<PolicySkeleton>

    imported policy object

• importPolicies:function

  • importPolicies(
        importData: PolicyExportInterface,
        options?: PolicyImportOptions,
    ): Promise<PolicySkeleton[]>

    Import policies

    Parameters

    • importData: PolicyExportInterface

      import data
    • Optionaloptions: PolicyImportOptions

      import options

    Returns Promise<PolicySkeleton[]>

    array of imported policy objects

• importPolicy:function

  • importPolicy(
        policyId: string,
        importData: PolicyExportInterface,
        options?: PolicyImportOptions,
    ): Promise<PolicySkeleton>

    Import policy by id

    Parameters

    • policyId: string

      policy id
    • importData: PolicyExportInterface

      import data
    • Optionaloptions: PolicyImportOptions

      import options

    Returns Promise<PolicySkeleton>

    imported policy object

• putPolicy:function

  • putPolicy(policyId: string, policyData: PolicySkeleton): Promise<PolicySkeleton>

    Update or create policy

    Parameters

    • policyId: string

      policy id/name
    • policyData: PolicySkeleton

      policy object

    Returns Promise<PolicySkeleton>

    promise resolving to a policy object

    Deprecated

    since v2.0.0 use Agent.updatePolicy | updatePolicy or Agent.createPolicy | createPolicy instead

    updatePolicy(policyId: string, policyData: PolicySkeleton): Promise<PolicySkeleton>
    createPolicy(policyId: string, policyData: PolicySkeleton): Promise<PolicySkeleton>
    Copy

• readPolicies:function

  • readPolicies(): Promise<PolicySkeleton[]>

    Read all policies

    Returns Promise<PolicySkeleton[]>

    a promise that resolves to an array of policy set objects

• readPoliciesByPolicySet:function

  • readPoliciesByPolicySet(policySetId: string): Promise<PolicySkeleton[]>

    Get policies by policy set

    Parameters

    • policySetId: string

      policy set id/name

    Returns Promise<PolicySkeleton[]>

    a promise resolving to an array of policy objects

• readPolicy:function

  • readPolicy(policyId: string): Promise<PolicySkeleton>

    Get policy

    Parameters

    • policyId: string

      policy id/name

    Returns Promise<PolicySkeleton>

    promise resolving to a policy object

• updatePolicy:function

  • updatePolicy(
        policyId: string,
        policyData: PolicySkeleton,
    ): Promise<PolicySkeleton>

    Update or create policy

    Parameters

    • policyId: string

      policy id/name
    • policyData: PolicySkeleton

      policy object

    Returns Promise<PolicySkeleton>

    promise resolving to a policy object