Skip to main content

Class: DlpProfilesClient

Defined in: src/management/dlp-profiles.ts:17

Client for listing DLP profiles.

Constructors​

Constructor​

new DlpProfilesClient(opts): DlpProfilesClient;

Defined in: src/management/dlp-profiles.ts:22

Parameters​

ParameterType
optsDlpProfilesClientOptions

Returns​

DlpProfilesClient

Methods​

list()​

list(): Promise<objectOutputType<{
  dlp_profiles: ZodOptional<ZodArray<ZodObject<{
     name: ZodString;
     uuid: ZodString;
     id: ZodOptional<ZodString>;
     version: ZodOptional<ZodString>;
     rule1: ZodOptional<ZodObject<{
        action: ZodOptional<...>;
      }, "passthrough", ZodTypeAny, objectOutputType<{
        action: ...;
      }, ZodTypeAny, "passthrough">, objectInputType<{
        action: ...;
     }, ZodTypeAny, "passthrough">>>;
     rule2: ZodOptional<ZodObject<{
        action: ZodOptional<...>;
      }, "passthrough", ZodTypeAny, objectOutputType<{
        action: ...;
      }, ZodTypeAny, "passthrough">, objectInputType<{
        action: ...;
     }, ZodTypeAny, "passthrough">>>;
     log-severity: ZodOptional<ZodString>;
     non-file-based: ZodOptional<ZodString>;
     file-based: ZodOptional<ZodString>;
   }, "passthrough", ZodTypeAny, objectOutputType<{
     name: ZodString;
     uuid: ZodString;
     id: ZodOptional<ZodString>;
     version: ZodOptional<ZodString>;
     rule1: ZodOptional<ZodObject<{
        action: ...;
     }, "passthrough", ZodTypeAny, objectOutputType<..., ..., ...>, objectInputType<..., ..., ...>>>;
     rule2: ZodOptional<ZodObject<{
        action: ...;
     }, "passthrough", ZodTypeAny, objectOutputType<..., ..., ...>, objectInputType<..., ..., ...>>>;
     log-severity: ZodOptional<ZodString>;
     non-file-based: ZodOptional<ZodString>;
     file-based: ZodOptional<ZodString>;
   }, ZodTypeAny, "passthrough">, objectInputType<{
     name: ZodString;
     uuid: ZodString;
     id: ZodOptional<ZodString>;
     version: ZodOptional<ZodString>;
     rule1: ZodOptional<ZodObject<{
        action: ...;
     }, "passthrough", ZodTypeAny, objectOutputType<..., ..., ...>, objectInputType<..., ..., ...>>>;
     rule2: ZodOptional<ZodObject<{
        action: ...;
     }, "passthrough", ZodTypeAny, objectOutputType<..., ..., ...>, objectInputType<..., ..., ...>>>;
     log-severity: ZodOptional<ZodString>;
     non-file-based: ZodOptional<ZodString>;
     file-based: ZodOptional<ZodString>;
  }, ZodTypeAny, "passthrough">>, "many">>;
}, ZodTypeAny, "passthrough">>;

Defined in: src/management/dlp-profiles.ts:41

List all DLP profiles for the TSG.

Returns​

Promise<objectOutputType<{ dlp_profiles: ZodOptional<ZodArray<ZodObject<{ name: ZodString; uuid: ZodString; id: ZodOptional<ZodString>; version: ZodOptional<ZodString>; rule1: ZodOptional<ZodObject<{ action: ZodOptional<...>; }, "passthrough", ZodTypeAny, objectOutputType<{ action: ...; }, ZodTypeAny, "passthrough">, objectInputType<{ action: ...; }, ZodTypeAny, "passthrough">>>; rule2: ZodOptional<ZodObject<{ action: ZodOptional<...>; }, "passthrough", ZodTypeAny, objectOutputType<{ action: ...; }, ZodTypeAny, "passthrough">, objectInputType<{ action: ...; }, ZodTypeAny, "passthrough">>>; log-severity: ZodOptional<ZodString>; non-file-based: ZodOptional<ZodString>; file-based: ZodOptional<ZodString>; }, "passthrough", ZodTypeAny, objectOutputType<{ name: ZodString; uuid: ZodString; id: ZodOptional<ZodString>; version: ZodOptional<ZodString>; rule1: ZodOptional<ZodObject<{ action: ...; }, "passthrough", ZodTypeAny, objectOutputType<..., ..., ...>, objectInputType<..., ..., ...>>>; rule2: ZodOptional<ZodObject<{ action: ...; }, "passthrough", ZodTypeAny, objectOutputType<..., ..., ...>, objectInputType<..., ..., ...>>>; log-severity: ZodOptional<ZodString>; non-file-based: ZodOptional<ZodString>; file-based: ZodOptional<ZodString>; }, ZodTypeAny, "passthrough">, objectInputType<{ name: ZodString; uuid: ZodString; id: ZodOptional<ZodString>; version: ZodOptional<ZodString>; rule1: ZodOptional<ZodObject<{ action: ...; }, "passthrough", ZodTypeAny, objectOutputType<..., ..., ...>, objectInputType<..., ..., ...>>>; rule2: ZodOptional<ZodObject<{ action: ...; }, "passthrough", ZodTypeAny, objectOutputType<..., ..., ...>, objectInputType<..., ..., ...>>>; log-severity: ZodOptional<ZodString>; non-file-based: ZodOptional<ZodString>; file-based: ZodOptional<ZodString>; }, ZodTypeAny, "passthrough">>, "many">>; }, ZodTypeAny, "passthrough">>

List of DLP profiles.

Example​

import { ManagementClient } from '@cdot65/prisma-airs-sdk';
const mgmt = new ManagementClient(); // reads PANW_MGMT_* env vars

const result = await mgmt.dlpProfiles.list();
// result =>
// { dlp_profiles: [ { name: 'pci-dss', uuid: 'u1' } ] }