Class: DataProfilesClient

Defined in: src/management/dlp/data-profiles.ts:40

Client for the DLP Data Profiles resource (/v2/api/data-profiles).

CRUD-without-DELETE: list, create, get, replace (PUT), patch (JSON Merge Patch). The DLP spec does not expose a DELETE for data profiles — to remove a profile, patch it to a deleted lifecycle state via the underlying API (typically profile_status: "deleted").

Constructors

Constructor

new DataProfilesClient(opts): DataProfilesClient;

Defined in: src/management/dlp/data-profiles.ts:45

Parameters

Parameter	Type
`opts`	`DataProfilesClientOptions`

Returns

DataProfilesClient

Methods

list()

list(params?): Promise<objectOutputType<{
  content: ZodArray<ZodObject<{
     id: ZodOptional<ZodNullable<ZodString>>;
     name: ZodOptional<ZodNullable<ZodString>>;
     description: ZodOptional<ZodNullable<ZodString>>;
     tenant_id: ZodOptional<ZodNullable<ZodString>>;
     type: ZodOptional<ZodNullable<ZodEnum<["custom", "predefined"]>>>;
     profile_status: ZodOptional<ZodNullable<ZodEnum<["active", "disabled", "deleted"]>>>;
     profile_type: ZodOptional<ZodNullable<ZodEnum<["basic", "advanced"]>>>;
     is_granular_data_profile: ZodOptional<ZodNullable<ZodBoolean>>;
     is_parent_managed: ZodOptional<ZodNullable<ZodBoolean>>;
     version: ZodOptional<ZodNullable<ZodNumber>>;
     advance_data_patterns_rule_request: ZodOptional<ZodNullable<ZodArray<ZodString, "many">>>;
     detection_rules: ZodOptional<ZodNullable<ZodArray<ZodDiscriminatedUnion<"rule_type", [..., ...]>, "many">>>;
     audit_metadata: ZodOptional<ZodNullable<ZodObject<{
        created_at: ZodOptional<...>;
        created_by: ZodOptional<...>;
        updated_at: ZodOptional<...>;
        updated_by: ZodOptional<...>;
      }, "passthrough", ZodTypeAny, objectOutputType<{
        created_at: ...;
        created_by: ...;
        updated_at: ...;
        updated_by: ...;
      }, ZodTypeAny, "passthrough">, objectInputType<{
        created_at: ...;
        created_by: ...;
        updated_at: ...;
        updated_by: ...;
     }, ZodTypeAny, "passthrough">>>>;
   }, "passthrough", ZodTypeAny, objectOutputType<{
     id: ZodOptional<ZodNullable<ZodString>>;
     name: ZodOptional<ZodNullable<ZodString>>;
     description: ZodOptional<ZodNullable<ZodString>>;
     tenant_id: ZodOptional<ZodNullable<ZodString>>;
     type: ZodOptional<ZodNullable<ZodEnum<[..., ...]>>>;
     profile_status: ZodOptional<ZodNullable<ZodEnum<[..., ..., ...]>>>;
     profile_type: ZodOptional<ZodNullable<ZodEnum<[..., ...]>>>;
     is_granular_data_profile: ZodOptional<ZodNullable<ZodBoolean>>;
     is_parent_managed: ZodOptional<ZodNullable<ZodBoolean>>;
     version: ZodOptional<ZodNullable<ZodNumber>>;
     advance_data_patterns_rule_request: ZodOptional<ZodNullable<ZodArray<ZodString, "many">>>;
     detection_rules: ZodOptional<ZodNullable<ZodArray<ZodDiscriminatedUnion<..., ...>, "many">>>;
     audit_metadata: ZodOptional<ZodNullable<ZodObject<{
        created_at: ...;
        created_by: ...;
        updated_at: ...;
        updated_by: ...;
     }, "passthrough", ZodTypeAny, objectOutputType<..., ..., ...>, objectInputType<..., ..., ...>>>>;
   }, ZodTypeAny, "passthrough">, objectInputType<{
     id: ZodOptional<ZodNullable<ZodString>>;
     name: ZodOptional<ZodNullable<ZodString>>;
     description: ZodOptional<ZodNullable<ZodString>>;
     tenant_id: ZodOptional<ZodNullable<ZodString>>;
     type: ZodOptional<ZodNullable<ZodEnum<[..., ...]>>>;
     profile_status: ZodOptional<ZodNullable<ZodEnum<[..., ..., ...]>>>;
     profile_type: ZodOptional<ZodNullable<ZodEnum<[..., ...]>>>;
     is_granular_data_profile: ZodOptional<ZodNullable<ZodBoolean>>;
     is_parent_managed: ZodOptional<ZodNullable<ZodBoolean>>;
     version: ZodOptional<ZodNullable<ZodNumber>>;
     advance_data_patterns_rule_request: ZodOptional<ZodNullable<ZodArray<ZodString, "many">>>;
     detection_rules: ZodOptional<ZodNullable<ZodArray<ZodDiscriminatedUnion<..., ...>, "many">>>;
     audit_metadata: ZodOptional<ZodNullable<ZodObject<{
        created_at: ...;
        created_by: ...;
        updated_at: ...;
        updated_by: ...;
     }, "passthrough", ZodTypeAny, objectOutputType<..., ..., ...>, objectInputType<..., ..., ...>>>>;
  }, ZodTypeAny, "passthrough">>, "many">;
  empty: ZodOptional<ZodBoolean>;
  first: ZodOptional<ZodBoolean>;
  last: ZodOptional<ZodBoolean>;
  number: ZodOptional<ZodNumber>;
  numberOfElements: ZodOptional<ZodNumber>;
  pageable: ZodOptional<ZodObject<{
     offset: ZodOptional<ZodNumber>;
     pageNumber: ZodOptional<ZodNumber>;
     pageSize: ZodOptional<ZodNumber>;
     paged: ZodOptional<ZodBoolean>;
     unpaged: ZodOptional<ZodBoolean>;
     sort: ZodOptional<ZodObject<{
        empty: ZodOptional<ZodBoolean>;
        sorted: ZodOptional<ZodBoolean>;
        unsorted: ZodOptional<ZodBoolean>;
      }, "passthrough", ZodTypeAny, objectOutputType<{
        empty: ZodOptional<...>;
        sorted: ZodOptional<...>;
        unsorted: ZodOptional<...>;
      }, ZodTypeAny, "passthrough">, objectInputType<{
        empty: ZodOptional<...>;
        sorted: ZodOptional<...>;
        unsorted: ZodOptional<...>;
     }, ZodTypeAny, "passthrough">>>;
   }, "passthrough", ZodTypeAny, objectOutputType<{
     offset: ZodOptional<ZodNumber>;
     pageNumber: ZodOptional<ZodNumber>;
     pageSize: ZodOptional<ZodNumber>;
     paged: ZodOptional<ZodBoolean>;
     unpaged: ZodOptional<ZodBoolean>;
     sort: ZodOptional<ZodObject<{
        empty: ZodOptional<...>;
        sorted: ZodOptional<...>;
        unsorted: ZodOptional<...>;
      }, "passthrough", ZodTypeAny, objectOutputType<{
        empty: ...;
        sorted: ...;
        unsorted: ...;
      }, ZodTypeAny, "passthrough">, objectInputType<{
        empty: ...;
        sorted: ...;
        unsorted: ...;
     }, ZodTypeAny, "passthrough">>>;
   }, ZodTypeAny, "passthrough">, objectInputType<{
     offset: ZodOptional<ZodNumber>;
     pageNumber: ZodOptional<ZodNumber>;
     pageSize: ZodOptional<ZodNumber>;
     paged: ZodOptional<ZodBoolean>;
     unpaged: ZodOptional<ZodBoolean>;
     sort: ZodOptional<ZodObject<{
        empty: ZodOptional<...>;
        sorted: ZodOptional<...>;
        unsorted: ZodOptional<...>;
      }, "passthrough", ZodTypeAny, objectOutputType<{
        empty: ...;
        sorted: ...;
        unsorted: ...;
      }, ZodTypeAny, "passthrough">, objectInputType<{
        empty: ...;
        sorted: ...;
        unsorted: ...;
     }, ZodTypeAny, "passthrough">>>;
  }, ZodTypeAny, "passthrough">>>;
  size: ZodOptional<ZodNumber>;
  sort: ZodOptional<ZodObject<{
     empty: ZodOptional<ZodBoolean>;
     sorted: ZodOptional<ZodBoolean>;
     unsorted: ZodOptional<ZodBoolean>;
   }, "passthrough", ZodTypeAny, objectOutputType<{
     empty: ZodOptional<ZodBoolean>;
     sorted: ZodOptional<ZodBoolean>;
     unsorted: ZodOptional<ZodBoolean>;
   }, ZodTypeAny, "passthrough">, objectInputType<{
     empty: ZodOptional<ZodBoolean>;
     sorted: ZodOptional<ZodBoolean>;
     unsorted: ZodOptional<ZodBoolean>;
  }, ZodTypeAny, "passthrough">>>;
  totalElements: ZodOptional<ZodNumber>;
  totalPages: ZodOptional<ZodNumber>;
}, ZodTypeAny, "passthrough">>;

Defined in: src/management/dlp/data-profiles.ts:67

List data profiles. Returns the Spring Page<> envelope verbatim so callers can inspect totalElements, pageable, etc.

Parameters

Parameter	Type
`params`	`DataProfileListParams`

Returns

Promise<objectOutputType<{ content: ZodArray<ZodObject<{ id: ZodOptional<ZodNullable<ZodString>>; name: ZodOptional<ZodNullable<ZodString>>; description: ZodOptional<ZodNullable<ZodString>>; tenant_id: ZodOptional<ZodNullable<ZodString>>; type: ZodOptional<ZodNullable<ZodEnum<["custom", "predefined"]>>>; profile_status: ZodOptional<ZodNullable<ZodEnum<["active", "disabled", "deleted"]>>>; profile_type: ZodOptional<ZodNullable<ZodEnum<["basic", "advanced"]>>>; is_granular_data_profile: ZodOptional<ZodNullable<ZodBoolean>>; is_parent_managed: ZodOptional<ZodNullable<ZodBoolean>>; version: ZodOptional<ZodNullable<ZodNumber>>; advance_data_patterns_rule_request: ZodOptional<ZodNullable<ZodArray<ZodString, "many">>>; detection_rules: ZodOptional<ZodNullable<ZodArray<ZodDiscriminatedUnion<"rule_type", [..., ...]>, "many">>>; audit_metadata: ZodOptional<ZodNullable<ZodObject<{ created_at: ZodOptional<...>; created_by: ZodOptional<...>; updated_at: ZodOptional<...>; updated_by: ZodOptional<...>; }, "passthrough", ZodTypeAny, objectOutputType<{ created_at: ...; created_by: ...; updated_at: ...; updated_by: ...; }, ZodTypeAny, "passthrough">, objectInputType<{ created_at: ...; created_by: ...; updated_at: ...; updated_by: ...; }, ZodTypeAny, "passthrough">>>>; }, "passthrough", ZodTypeAny, objectOutputType<{ id: ZodOptional<ZodNullable<ZodString>>; name: ZodOptional<ZodNullable<ZodString>>; description: ZodOptional<ZodNullable<ZodString>>; tenant_id: ZodOptional<ZodNullable<ZodString>>; type: ZodOptional<ZodNullable<ZodEnum<[..., ...]>>>; profile_status: ZodOptional<ZodNullable<ZodEnum<[..., ..., ...]>>>; profile_type: ZodOptional<ZodNullable<ZodEnum<[..., ...]>>>; is_granular_data_profile: ZodOptional<ZodNullable<ZodBoolean>>; is_parent_managed: ZodOptional<ZodNullable<ZodBoolean>>; version: ZodOptional<ZodNullable<ZodNumber>>; advance_data_patterns_rule_request: ZodOptional<ZodNullable<ZodArray<ZodString, "many">>>; detection_rules: ZodOptional<ZodNullable<ZodArray<ZodDiscriminatedUnion<..., ...>, "many">>>; audit_metadata: ZodOptional<ZodNullable<ZodObject<{ created_at: ...; created_by: ...; updated_at: ...; updated_by: ...; }, "passthrough", ZodTypeAny, objectOutputType<..., ..., ...>, objectInputType<..., ..., ...>>>>; }, ZodTypeAny, "passthrough">, objectInputType<{ id: ZodOptional<ZodNullable<ZodString>>; name: ZodOptional<ZodNullable<ZodString>>; description: ZodOptional<ZodNullable<ZodString>>; tenant_id: ZodOptional<ZodNullable<ZodString>>; type: ZodOptional<ZodNullable<ZodEnum<[..., ...]>>>; profile_status: ZodOptional<ZodNullable<ZodEnum<[..., ..., ...]>>>; profile_type: ZodOptional<ZodNullable<ZodEnum<[..., ...]>>>; is_granular_data_profile: ZodOptional<ZodNullable<ZodBoolean>>; is_parent_managed: ZodOptional<ZodNullable<ZodBoolean>>; version: ZodOptional<ZodNullable<ZodNumber>>; advance_data_patterns_rule_request: ZodOptional<ZodNullable<ZodArray<ZodString, "many">>>; detection_rules: ZodOptional<ZodNullable<ZodArray<ZodDiscriminatedUnion<..., ...>, "many">>>; audit_metadata: ZodOptional<ZodNullable<ZodObject<{ created_at: ...; created_by: ...; updated_at: ...; updated_by: ...; }, "passthrough", ZodTypeAny, objectOutputType<..., ..., ...>, objectInputType<..., ..., ...>>>>; }, ZodTypeAny, "passthrough">>, "many">; empty: ZodOptional<ZodBoolean>; first: ZodOptional<ZodBoolean>; last: ZodOptional<ZodBoolean>; number: ZodOptional<ZodNumber>; numberOfElements: ZodOptional<ZodNumber>; pageable: ZodOptional<ZodObject<{ offset: ZodOptional<ZodNumber>; pageNumber: ZodOptional<ZodNumber>; pageSize: ZodOptional<ZodNumber>; paged: ZodOptional<ZodBoolean>; unpaged: ZodOptional<ZodBoolean>; sort: ZodOptional<ZodObject<{ empty: ZodOptional<ZodBoolean>; sorted: ZodOptional<ZodBoolean>; unsorted: ZodOptional<ZodBoolean>; }, "passthrough", ZodTypeAny, objectOutputType<{ empty: ZodOptional<...>; sorted: ZodOptional<...>; unsorted: ZodOptional<...>; }, ZodTypeAny, "passthrough">, objectInputType<{ empty: ZodOptional<...>; sorted: ZodOptional<...>; unsorted: ZodOptional<...>; }, ZodTypeAny, "passthrough">>>; }, "passthrough", ZodTypeAny, objectOutputType<{ offset: ZodOptional<ZodNumber>; pageNumber: ZodOptional<ZodNumber>; pageSize: ZodOptional<ZodNumber>; paged: ZodOptional<ZodBoolean>; unpaged: ZodOptional<ZodBoolean>; sort: ZodOptional<ZodObject<{ empty: ZodOptional<...>; sorted: ZodOptional<...>; unsorted: ZodOptional<...>; }, "passthrough", ZodTypeAny, objectOutputType<{ empty: ...; sorted: ...; unsorted: ...; }, ZodTypeAny, "passthrough">, objectInputType<{ empty: ...; sorted: ...; unsorted: ...; }, ZodTypeAny, "passthrough">>>; }, ZodTypeAny, "passthrough">, objectInputType<{ offset: ZodOptional<ZodNumber>; pageNumber: ZodOptional<ZodNumber>; pageSize: ZodOptional<ZodNumber>; paged: ZodOptional<ZodBoolean>; unpaged: ZodOptional<ZodBoolean>; sort: ZodOptional<ZodObject<{ empty: ZodOptional<...>; sorted: ZodOptional<...>; unsorted: ZodOptional<...>; }, "passthrough", ZodTypeAny, objectOutputType<{ empty: ...; sorted: ...; unsorted: ...; }, ZodTypeAny, "passthrough">, objectInputType<{ empty: ...; sorted: ...; unsorted: ...; }, ZodTypeAny, "passthrough">>>; }, ZodTypeAny, "passthrough">>>; size: ZodOptional<ZodNumber>; sort: ZodOptional<ZodObject<{ empty: ZodOptional<ZodBoolean>; sorted: ZodOptional<ZodBoolean>; unsorted: ZodOptional<ZodBoolean>; }, "passthrough", ZodTypeAny, objectOutputType<{ empty: ZodOptional<ZodBoolean>; sorted: ZodOptional<ZodBoolean>; unsorted: ZodOptional<ZodBoolean>; }, ZodTypeAny, "passthrough">, objectInputType<{ empty: ZodOptional<ZodBoolean>; sorted: ZodOptional<ZodBoolean>; unsorted: ZodOptional<ZodBoolean>; }, ZodTypeAny, "passthrough">>>; totalElements: ZodOptional<ZodNumber>; totalPages: ZodOptional<ZodNumber>; }, ZodTypeAny, "passthrough">>

Example

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

const page = await mgmt.dlp.dataProfiles.list({ size: 5, sort: ['name,asc'] });
// page =>
// {
//   content: [{ id: 'prof-1', name: 'Confidential', profile_type: 'advanced', profile_status: 'active' }],
//   totalElements: 1, totalPages: 1, number: 0, size: 20, first: true, last: true
// }

create()

create(body): Promise<objectOutputType<{
  id: ZodOptional<ZodNullable<ZodString>>;
  name: ZodOptional<ZodNullable<ZodString>>;
  description: ZodOptional<ZodNullable<ZodString>>;
  tenant_id: ZodOptional<ZodNullable<ZodString>>;
  type: ZodOptional<ZodNullable<ZodEnum<["custom", "predefined"]>>>;
  profile_status: ZodOptional<ZodNullable<ZodEnum<["active", "disabled", "deleted"]>>>;
  profile_type: ZodOptional<ZodNullable<ZodEnum<["basic", "advanced"]>>>;
  is_granular_data_profile: ZodOptional<ZodNullable<ZodBoolean>>;
  is_parent_managed: ZodOptional<ZodNullable<ZodBoolean>>;
  version: ZodOptional<ZodNullable<ZodNumber>>;
  advance_data_patterns_rule_request: ZodOptional<ZodNullable<ZodArray<ZodString, "many">>>;
  detection_rules: ZodOptional<ZodNullable<ZodArray<ZodDiscriminatedUnion<"rule_type", [ZodObject<{
     rule_type: ZodLiteral<...>;
     expression_tree: ZodOptional<...>;
   }, "passthrough", ZodTypeAny, objectOutputType<{
     rule_type: ...;
     expression_tree: ...;
   }, ZodTypeAny, "passthrough">, objectInputType<{
     rule_type: ...;
     expression_tree: ...;
   }, ZodTypeAny, "passthrough">>, ZodObject<{
     rule_type: ZodLiteral<...>;
     multi_profile: ZodOptional<...>;
   }, "passthrough", ZodTypeAny, objectOutputType<{
     rule_type: ...;
     multi_profile: ...;
   }, ZodTypeAny, "passthrough">, objectInputType<{
     rule_type: ...;
     multi_profile: ...;
  }, ZodTypeAny, "passthrough">>]>, "many">>>;
  audit_metadata: ZodOptional<ZodNullable<ZodObject<{
     created_at: ZodOptional<ZodNullable<ZodUnion<[..., ...]>>>;
     created_by: ZodOptional<ZodNullable<ZodString>>;
     updated_at: ZodOptional<ZodNullable<ZodUnion<[..., ...]>>>;
     updated_by: ZodOptional<ZodNullable<ZodString>>;
   }, "passthrough", ZodTypeAny, objectOutputType<{
     created_at: ZodOptional<ZodNullable<ZodUnion<...>>>;
     created_by: ZodOptional<ZodNullable<ZodString>>;
     updated_at: ZodOptional<ZodNullable<ZodUnion<...>>>;
     updated_by: ZodOptional<ZodNullable<ZodString>>;
   }, ZodTypeAny, "passthrough">, objectInputType<{
     created_at: ZodOptional<ZodNullable<ZodUnion<...>>>;
     created_by: ZodOptional<ZodNullable<ZodString>>;
     updated_at: ZodOptional<ZodNullable<ZodUnion<...>>>;
     updated_by: ZodOptional<ZodNullable<ZodString>>;
  }, ZodTypeAny, "passthrough">>>>;
}, ZodTypeAny, "passthrough">>;

Defined in: src/management/dlp/data-profiles.ts:107

Create a new data profile.

Parameters

Parameter	Type
`body`	`objectOutputType`

Returns

Promise<objectOutputType<{ id: ZodOptional<ZodNullable<ZodString>>; name: ZodOptional<ZodNullable<ZodString>>; description: ZodOptional<ZodNullable<ZodString>>; tenant_id: ZodOptional<ZodNullable<ZodString>>; type: ZodOptional<ZodNullable<ZodEnum<["custom", "predefined"]>>>; profile_status: ZodOptional<ZodNullable<ZodEnum<["active", "disabled", "deleted"]>>>; profile_type: ZodOptional<ZodNullable<ZodEnum<["basic", "advanced"]>>>; is_granular_data_profile: ZodOptional<ZodNullable<ZodBoolean>>; is_parent_managed: ZodOptional<ZodNullable<ZodBoolean>>; version: ZodOptional<ZodNullable<ZodNumber>>; advance_data_patterns_rule_request: ZodOptional<ZodNullable<ZodArray<ZodString, "many">>>; detection_rules: ZodOptional<ZodNullable<ZodArray<ZodDiscriminatedUnion<"rule_type", [ZodObject<{ rule_type: ZodLiteral<...>; expression_tree: ZodOptional<...>; }, "passthrough", ZodTypeAny, objectOutputType<{ rule_type: ...; expression_tree: ...; }, ZodTypeAny, "passthrough">, objectInputType<{ rule_type: ...; expression_tree: ...; }, ZodTypeAny, "passthrough">>, ZodObject<{ rule_type: ZodLiteral<...>; multi_profile: ZodOptional<...>; }, "passthrough", ZodTypeAny, objectOutputType<{ rule_type: ...; multi_profile: ...; }, ZodTypeAny, "passthrough">, objectInputType<{ rule_type: ...; multi_profile: ...; }, ZodTypeAny, "passthrough">>]>, "many">>>; audit_metadata: ZodOptional<ZodNullable<ZodObject<{ created_at: ZodOptional<ZodNullable<ZodUnion<[..., ...]>>>; created_by: ZodOptional<ZodNullable<ZodString>>; updated_at: ZodOptional<ZodNullable<ZodUnion<[..., ...]>>>; updated_by: ZodOptional<ZodNullable<ZodString>>; }, "passthrough", ZodTypeAny, objectOutputType<{ created_at: ZodOptional<ZodNullable<ZodUnion<...>>>; created_by: ZodOptional<ZodNullable<ZodString>>; updated_at: ZodOptional<ZodNullable<ZodUnion<...>>>; updated_by: ZodOptional<ZodNullable<ZodString>>; }, ZodTypeAny, "passthrough">, objectInputType<{ created_at: ZodOptional<ZodNullable<ZodUnion<...>>>; created_by: ZodOptional<ZodNullable<ZodString>>; updated_at: ZodOptional<ZodNullable<ZodUnion<...>>>; updated_by: ZodOptional<ZodNullable<ZodString>>; }, ZodTypeAny, "passthrough">>>>; }, ZodTypeAny, "passthrough">>

Example

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

const created = await mgmt.dlp.dataProfiles.create({
  name: 'example-profile',
  detection_rules: [
    {
      rule_type: 'expression_tree',
      expression_tree: {
        operator_type: 'and',
        rule_item: { detection_technique: 'regex', match_type: 'include' },
      },
    },
  ],
});
// created =>
// { id: 'prof-1', name: 'example-profile', profile_type: 'advanced', profile_status: 'active' }

get()

get(resourceId): Promise<objectOutputType<{
  id: ZodOptional<ZodNullable<ZodString>>;
  name: ZodOptional<ZodNullable<ZodString>>;
  description: ZodOptional<ZodNullable<ZodString>>;
  tenant_id: ZodOptional<ZodNullable<ZodString>>;
  type: ZodOptional<ZodNullable<ZodEnum<["custom", "predefined"]>>>;
  profile_status: ZodOptional<ZodNullable<ZodEnum<["active", "disabled", "deleted"]>>>;
  profile_type: ZodOptional<ZodNullable<ZodEnum<["basic", "advanced"]>>>;
  is_granular_data_profile: ZodOptional<ZodNullable<ZodBoolean>>;
  is_parent_managed: ZodOptional<ZodNullable<ZodBoolean>>;
  version: ZodOptional<ZodNullable<ZodNumber>>;
  advance_data_patterns_rule_request: ZodOptional<ZodNullable<ZodArray<ZodString, "many">>>;
  detection_rules: ZodOptional<ZodNullable<ZodArray<ZodDiscriminatedUnion<"rule_type", [ZodObject<{
     rule_type: ZodLiteral<...>;
     expression_tree: ZodOptional<...>;
   }, "passthrough", ZodTypeAny, objectOutputType<{
     rule_type: ...;
     expression_tree: ...;
   }, ZodTypeAny, "passthrough">, objectInputType<{
     rule_type: ...;
     expression_tree: ...;
   }, ZodTypeAny, "passthrough">>, ZodObject<{
     rule_type: ZodLiteral<...>;
     multi_profile: ZodOptional<...>;
   }, "passthrough", ZodTypeAny, objectOutputType<{
     rule_type: ...;
     multi_profile: ...;
   }, ZodTypeAny, "passthrough">, objectInputType<{
     rule_type: ...;
     multi_profile: ...;
  }, ZodTypeAny, "passthrough">>]>, "many">>>;
  audit_metadata: ZodOptional<ZodNullable<ZodObject<{
     created_at: ZodOptional<ZodNullable<ZodUnion<[..., ...]>>>;
     created_by: ZodOptional<ZodNullable<ZodString>>;
     updated_at: ZodOptional<ZodNullable<ZodUnion<[..., ...]>>>;
     updated_by: ZodOptional<ZodNullable<ZodString>>;
   }, "passthrough", ZodTypeAny, objectOutputType<{
     created_at: ZodOptional<ZodNullable<ZodUnion<...>>>;
     created_by: ZodOptional<ZodNullable<ZodString>>;
     updated_at: ZodOptional<ZodNullable<ZodUnion<...>>>;
     updated_by: ZodOptional<ZodNullable<ZodString>>;
   }, ZodTypeAny, "passthrough">, objectInputType<{
     created_at: ZodOptional<ZodNullable<ZodUnion<...>>>;
     created_by: ZodOptional<ZodNullable<ZodString>>;
     updated_at: ZodOptional<ZodNullable<ZodUnion<...>>>;
     updated_by: ZodOptional<ZodNullable<ZodString>>;
  }, ZodTypeAny, "passthrough">>>>;
}, ZodTypeAny, "passthrough">>;

Defined in: src/management/dlp/data-profiles.ts:131

Get a single data profile by resource ID.

Parameters

Parameter	Type
`resourceId`	`string`

Returns

Example

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

const profile = await mgmt.dlp.dataProfiles.get('prof-1');
// profile =>
// { id: 'prof-1', name: 'Confidential', profile_type: 'advanced', profile_status: 'active' }

replace()

replace(resourceId, body): Promise<objectOutputType<{
  id: ZodOptional<ZodNullable<ZodString>>;
  name: ZodOptional<ZodNullable<ZodString>>;
  description: ZodOptional<ZodNullable<ZodString>>;
  tenant_id: ZodOptional<ZodNullable<ZodString>>;
  type: ZodOptional<ZodNullable<ZodEnum<["custom", "predefined"]>>>;
  profile_status: ZodOptional<ZodNullable<ZodEnum<["active", "disabled", "deleted"]>>>;
  profile_type: ZodOptional<ZodNullable<ZodEnum<["basic", "advanced"]>>>;
  is_granular_data_profile: ZodOptional<ZodNullable<ZodBoolean>>;
  is_parent_managed: ZodOptional<ZodNullable<ZodBoolean>>;
  version: ZodOptional<ZodNullable<ZodNumber>>;
  advance_data_patterns_rule_request: ZodOptional<ZodNullable<ZodArray<ZodString, "many">>>;
  detection_rules: ZodOptional<ZodNullable<ZodArray<ZodDiscriminatedUnion<"rule_type", [ZodObject<{
     rule_type: ZodLiteral<...>;
     expression_tree: ZodOptional<...>;
   }, "passthrough", ZodTypeAny, objectOutputType<{
     rule_type: ...;
     expression_tree: ...;
   }, ZodTypeAny, "passthrough">, objectInputType<{
     rule_type: ...;
     expression_tree: ...;
   }, ZodTypeAny, "passthrough">>, ZodObject<{
     rule_type: ZodLiteral<...>;
     multi_profile: ZodOptional<...>;
   }, "passthrough", ZodTypeAny, objectOutputType<{
     rule_type: ...;
     multi_profile: ...;
   }, ZodTypeAny, "passthrough">, objectInputType<{
     rule_type: ...;
     multi_profile: ...;
  }, ZodTypeAny, "passthrough">>]>, "many">>>;
  audit_metadata: ZodOptional<ZodNullable<ZodObject<{
     created_at: ZodOptional<ZodNullable<ZodUnion<[..., ...]>>>;
     created_by: ZodOptional<ZodNullable<ZodString>>;
     updated_at: ZodOptional<ZodNullable<ZodUnion<[..., ...]>>>;
     updated_by: ZodOptional<ZodNullable<ZodString>>;
   }, "passthrough", ZodTypeAny, objectOutputType<{
     created_at: ZodOptional<ZodNullable<ZodUnion<...>>>;
     created_by: ZodOptional<ZodNullable<ZodString>>;
     updated_at: ZodOptional<ZodNullable<ZodUnion<...>>>;
     updated_by: ZodOptional<ZodNullable<ZodString>>;
   }, ZodTypeAny, "passthrough">, objectInputType<{
     created_at: ZodOptional<ZodNullable<ZodUnion<...>>>;
     created_by: ZodOptional<ZodNullable<ZodString>>;
     updated_at: ZodOptional<ZodNullable<ZodUnion<...>>>;
     updated_by: ZodOptional<ZodNullable<ZodString>>;
  }, ZodTypeAny, "passthrough">>>>;
}, ZodTypeAny, "passthrough">>;

Defined in: src/management/dlp/data-profiles.ts:166

Full-replace (PUT) the profile at resourceId. Returns the updated resource as the API echoes it back.

Parameters

Parameter	Type
`resourceId`	`string`
`body`	`objectOutputType`

Returns

Example

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

const updated = await mgmt.dlp.dataProfiles.replace('prof-1', {
  name: 'Confidential',
  detection_rules: [
    {
      rule_type: 'expression_tree',
      expression_tree: {
        operator_type: 'and',
        rule_item: { detection_technique: 'regex', match_type: 'include' },
      },
    },
  ],
});
// updated =>
// { id: 'prof-1', name: 'Confidential', profile_type: 'advanced', profile_status: 'active' }

patch()

patch(resourceId, body): Promise<objectOutputType<{
  id: ZodOptional<ZodNullable<ZodString>>;
  name: ZodOptional<ZodNullable<ZodString>>;
  description: ZodOptional<ZodNullable<ZodString>>;
  tenant_id: ZodOptional<ZodNullable<ZodString>>;
  type: ZodOptional<ZodNullable<ZodEnum<["custom", "predefined"]>>>;
  profile_status: ZodOptional<ZodNullable<ZodEnum<["active", "disabled", "deleted"]>>>;
  profile_type: ZodOptional<ZodNullable<ZodEnum<["basic", "advanced"]>>>;
  is_granular_data_profile: ZodOptional<ZodNullable<ZodBoolean>>;
  is_parent_managed: ZodOptional<ZodNullable<ZodBoolean>>;
  version: ZodOptional<ZodNullable<ZodNumber>>;
  advance_data_patterns_rule_request: ZodOptional<ZodNullable<ZodArray<ZodString, "many">>>;
  detection_rules: ZodOptional<ZodNullable<ZodArray<ZodDiscriminatedUnion<"rule_type", [ZodObject<{
     rule_type: ZodLiteral<...>;
     expression_tree: ZodOptional<...>;
   }, "passthrough", ZodTypeAny, objectOutputType<{
     rule_type: ...;
     expression_tree: ...;
   }, ZodTypeAny, "passthrough">, objectInputType<{
     rule_type: ...;
     expression_tree: ...;
   }, ZodTypeAny, "passthrough">>, ZodObject<{
     rule_type: ZodLiteral<...>;
     multi_profile: ZodOptional<...>;
   }, "passthrough", ZodTypeAny, objectOutputType<{
     rule_type: ...;
     multi_profile: ...;
   }, ZodTypeAny, "passthrough">, objectInputType<{
     rule_type: ...;
     multi_profile: ...;
  }, ZodTypeAny, "passthrough">>]>, "many">>>;
  audit_metadata: ZodOptional<ZodNullable<ZodObject<{
     created_at: ZodOptional<ZodNullable<ZodUnion<[..., ...]>>>;
     created_by: ZodOptional<ZodNullable<ZodString>>;
     updated_at: ZodOptional<ZodNullable<ZodUnion<[..., ...]>>>;
     updated_by: ZodOptional<ZodNullable<ZodString>>;
   }, "passthrough", ZodTypeAny, objectOutputType<{
     created_at: ZodOptional<ZodNullable<ZodUnion<...>>>;
     created_by: ZodOptional<ZodNullable<ZodString>>;
     updated_at: ZodOptional<ZodNullable<ZodUnion<...>>>;
     updated_by: ZodOptional<ZodNullable<ZodString>>;
   }, ZodTypeAny, "passthrough">, objectInputType<{
     created_at: ZodOptional<ZodNullable<ZodUnion<...>>>;
     created_by: ZodOptional<ZodNullable<ZodString>>;
     updated_at: ZodOptional<ZodNullable<ZodUnion<...>>>;
     updated_by: ZodOptional<ZodNullable<ZodString>>;
  }, ZodTypeAny, "passthrough">>>>;
}, ZodTypeAny, "passthrough">>;

Defined in: src/management/dlp/data-profiles.ts:199

Partial update via JSON Merge Patch (RFC 7396). Sent with Content-Type: application/merge-patch+json. Fields set to null clear server-side; omitted fields are left unchanged.

Parameters

Parameter	Type
`resourceId`	`string`
`body`	`objectOutputType`

Returns

Example

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

const patched = await mgmt.dlp.dataProfiles.patch('prof-1', {
  name: 'Confidential',
  profile_type: 'advanced',
  description: 'Updated by SDK',
});
// patched =>
// { id: 'prof-1', name: 'Confidential', profile_type: 'advanced', description: 'Updated by SDK' }

Constructors​

Constructor​

Parameters​

Returns​

Methods​

list()​

Parameters​

Returns​

Example​

create()​

Parameters​

Returns​

Example​

get()​

Parameters​

Returns​

Example​

replace()​

Parameters​

Returns​

Example​

patch()​

Parameters​

Returns​

Example​

Constructors

Constructor

Parameters

Returns

Methods

list()

Parameters

Returns

Example

create()

Parameters

Returns

Example

get()

Parameters

Returns

Example

replace()

Parameters

Returns

Example

patch()

Parameters

Returns

Example