Class: DataFilteringProfilesClient
Defined in: src/management/dlp/data-filtering-profiles.ts:41
Client for the DLP Data Filtering Profiles resource (/v2/api/data-filtering-profiles).
Read + full-replace surface only — the underlying API does not expose create or delete.
Constructors
Constructor
new DataFilteringProfilesClient(opts): DataFilteringProfilesClient;
Defined in: src/management/dlp/data-filtering-profiles.ts:46
Parameters
| Parameter | Type |
|---|---|
opts | DataFilteringProfilesClientOptions |
Returns
DataFilteringProfilesClient
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<ZodString>>;
data_profile_id: ZodOptional<ZodNullable<ZodNumber>>;
direction: ZodOptional<ZodNullable<ZodString>>;
file_based: ZodOptional<ZodNullable<ZodBoolean>>;
non_file_based: ZodOptional<ZodNullable<ZodBoolean>>;
log_severity: ZodOptional<ZodNullable<ZodString>>;
scan_type: ZodOptional<ZodNullable<ZodEnum<["include", "exclude"]>>>;
is_end_user_coaching_enabled: ZodOptional<ZodNullable<ZodBoolean>>;
is_granular_profile: ZodOptional<ZodNullable<ZodBoolean>>;
is_parent_managed: ZodOptional<ZodNullable<ZodBoolean>>;
euc_template_id: ZodOptional<ZodNullable<ZodString>>;
version: ZodOptional<ZodNullable<ZodNumber>>;
file_type: ZodOptional<ZodNullable<ZodArray<ZodString, "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">>>>;
criteria_details: ZodOptional<ZodNullable<ZodArray<ZodObject<{
action: ...;
dataProfileId: ...;
direction: ...;
euc_template_id: ...;
fileBased: ...;
fileTypes: ...;
is_end_user_coaching_enabled: ...;
logSeverity: ...;
nonFileBased: ...;
scanType: ...;
}, "passthrough", ZodTypeAny, objectOutputType<..., ..., ...>, objectInputType<..., ..., ...>>, "many">>>;
exception_rules: ZodOptional<ZodNullable<ZodArray<ZodObject<{
id: ...;
action: ...;
log_severity: ...;
data_profile_ids: ...;
destination_attributes: ...;
source_attributes: ...;
}, "passthrough", ZodTypeAny, objectOutputType<..., ..., ...>, objectInputType<..., ..., ...>>, "many">>>;
exclusions: ZodOptional<ZodNullable<ZodObject<{
app_exclusion_list: ZodOptional<...>;
url_exclusion_list: ZodOptional<...>;
exclusion_list: ZodOptional<...>;
}, "passthrough", ZodTypeAny, objectOutputType<{
app_exclusion_list: ...;
url_exclusion_list: ...;
exclusion_list: ...;
}, ZodTypeAny, "passthrough">, objectInputType<{
app_exclusion_list: ...;
url_exclusion_list: ...;
exclusion_list: ...;
}, ZodTypeAny, "passthrough">>>>;
rule1: ZodOptional<ZodNullable<ZodObject<{
action: ZodOptional<...>;
response_page: ZodOptional<...>;
show_rsp_page: ZodOptional<...>;
}, "passthrough", ZodTypeAny, objectOutputType<{
action: ...;
response_page: ...;
show_rsp_page: ...;
}, ZodTypeAny, "passthrough">, objectInputType<{
action: ...;
response_page: ...;
show_rsp_page: ...;
}, ZodTypeAny, "passthrough">>>>;
rule2: ZodOptional<ZodNullable<ZodObject<{
action: ZodOptional<...>;
response_page: ZodOptional<...>;
show_rsp_page: ZodOptional<...>;
}, "passthrough", ZodTypeAny, objectOutputType<{
action: ...;
response_page: ...;
show_rsp_page: ...;
}, ZodTypeAny, "passthrough">, objectInputType<{
action: ...;
response_page: ...;
show_rsp_page: ...;
}, 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<ZodString>>;
data_profile_id: ZodOptional<ZodNullable<ZodNumber>>;
direction: ZodOptional<ZodNullable<ZodString>>;
file_based: ZodOptional<ZodNullable<ZodBoolean>>;
non_file_based: ZodOptional<ZodNullable<ZodBoolean>>;
log_severity: ZodOptional<ZodNullable<ZodString>>;
scan_type: ZodOptional<ZodNullable<ZodEnum<[..., ...]>>>;
is_end_user_coaching_enabled: ZodOptional<ZodNullable<ZodBoolean>>;
is_granular_profile: ZodOptional<ZodNullable<ZodBoolean>>;
is_parent_managed: ZodOptional<ZodNullable<ZodBoolean>>;
euc_template_id: ZodOptional<ZodNullable<ZodString>>;
version: ZodOptional<ZodNullable<ZodNumber>>;
file_type: ZodOptional<ZodNullable<ZodArray<ZodString, "many">>>;
audit_metadata: ZodOptional<ZodNullable<ZodObject<{
created_at: ...;
created_by: ...;
updated_at: ...;
updated_by: ...;
}, "passthrough", ZodTypeAny, objectOutputType<..., ..., ...>, objectInputType<..., ..., ...>>>>;
criteria_details: ZodOptional<ZodNullable<ZodArray<ZodObject<..., ..., ..., ..., ...>, "many">>>;
exception_rules: ZodOptional<ZodNullable<ZodArray<ZodObject<..., ..., ..., ..., ...>, "many">>>;
exclusions: ZodOptional<ZodNullable<ZodObject<{
app_exclusion_list: ...;
url_exclusion_list: ...;
exclusion_list: ...;
}, "passthrough", ZodTypeAny, objectOutputType<..., ..., ...>, objectInputType<..., ..., ...>>>>;
rule1: ZodOptional<ZodNullable<ZodObject<{
action: ...;
response_page: ...;
show_rsp_page: ...;
}, "passthrough", ZodTypeAny, objectOutputType<..., ..., ...>, objectInputType<..., ..., ...>>>>;
rule2: ZodOptional<ZodNullable<ZodObject<{
action: ...;
response_page: ...;
show_rsp_page: ...;
}, "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<ZodString>>;
data_profile_id: ZodOptional<ZodNullable<ZodNumber>>;
direction: ZodOptional<ZodNullable<ZodString>>;
file_based: ZodOptional<ZodNullable<ZodBoolean>>;
non_file_based: ZodOptional<ZodNullable<ZodBoolean>>;
log_severity: ZodOptional<ZodNullable<ZodString>>;
scan_type: ZodOptional<ZodNullable<ZodEnum<[..., ...]>>>;
is_end_user_coaching_enabled: ZodOptional<ZodNullable<ZodBoolean>>;
is_granular_profile: ZodOptional<ZodNullable<ZodBoolean>>;
is_parent_managed: ZodOptional<ZodNullable<ZodBoolean>>;
euc_template_id: ZodOptional<ZodNullable<ZodString>>;
version: ZodOptional<ZodNullable<ZodNumber>>;
file_type: ZodOptional<ZodNullable<ZodArray<ZodString, "many">>>;
audit_metadata: ZodOptional<ZodNullable<ZodObject<{
created_at: ...;
created_by: ...;
updated_at: ...;
updated_by: ...;
}, "passthrough", ZodTypeAny, objectOutputType<..., ..., ...>, objectInputType<..., ..., ...>>>>;
criteria_details: ZodOptional<ZodNullable<ZodArray<ZodObject<..., ..., ..., ..., ...>, "many">>>;
exception_rules: ZodOptional<ZodNullable<ZodArray<ZodObject<..., ..., ..., ..., ...>, "many">>>;
exclusions: ZodOptional<ZodNullable<ZodObject<{
app_exclusion_list: ...;
url_exclusion_list: ...;
exclusion_list: ...;
}, "passthrough", ZodTypeAny, objectOutputType<..., ..., ...>, objectInputType<..., ..., ...>>>>;
rule1: ZodOptional<ZodNullable<ZodObject<{
action: ...;
response_page: ...;
show_rsp_page: ...;
}, "passthrough", ZodTypeAny, objectOutputType<..., ..., ...>, objectInputType<..., ..., ...>>>>;
rule2: ZodOptional<ZodNullable<ZodObject<{
action: ...;
response_page: ...;
show_rsp_page: ...;
}, "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-filtering-profiles.ts:68
List data filtering profiles. Returns the Spring Page<> envelope verbatim so callers can
inspect totalElements, pageable, etc. without a second round-trip.
Parameters
| Parameter | Type |
|---|---|
params | DataFilteringProfileListParams |
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<ZodString>>;
data_profile_id: ZodOptional<ZodNullable<ZodNumber>>;
direction: ZodOptional<ZodNullable<ZodString>>;
file_based: ZodOptional<ZodNullable<ZodBoolean>>;
non_file_based: ZodOptional<ZodNullable<ZodBoolean>>;
log_severity: ZodOptional<ZodNullable<ZodString>>;
scan_type: ZodOptional<ZodNullable<ZodEnum<["include", "exclude"]>>>;
is_end_user_coaching_enabled: ZodOptional<ZodNullable<ZodBoolean>>;
is_granular_profile: ZodOptional<ZodNullable<ZodBoolean>>;
is_parent_managed: ZodOptional<ZodNullable<ZodBoolean>>;
euc_template_id: ZodOptional<ZodNullable<ZodString>>;
version: ZodOptional<ZodNullable<ZodNumber>>;
file_type: ZodOptional<ZodNullable<ZodArray<ZodString, "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">>>>;
criteria_details: ZodOptional<ZodNullable<ZodArray<ZodObject<{
action: ...;
dataProfileId: ...;
direction: ...;
euc_template_id: ...;
fileBased: ...;
fileTypes: ...;
is_end_user_coaching_enabled: ...;
logSeverity: ...;
nonFileBased: ...;
scanType: ...;
}, "passthrough", ZodTypeAny, objectOutputType<..., ..., ...>, objectInputType<..., ..., ...>>, "many">>>;
exception_rules: ZodOptional<ZodNullable<ZodArray<ZodObject<{
id: ...;
action: ...;
log_severity: ...;
data_profile_ids: ...;
destination_attributes: ...;
source_attributes: ...;
}, "passthrough", ZodTypeAny, objectOutputType<..., ..., ...>, objectInputType<..., ..., ...>>, "many">>>;
exclusions: ZodOptional<ZodNullable<ZodObject<{
app_exclusion_list: ZodOptional<...>;
url_exclusion_list: ZodOptional<...>;
exclusion_list: ZodOptional<...>;
}, "passthrough", ZodTypeAny, objectOutputType<{
app_exclusion_list: ...;
url_exclusion_list: ...;
exclusion_list: ...;
}, ZodTypeAny, "passthrough">, objectInputType<{
app_exclusion_list: ...;
url_exclusion_list: ...;
exclusion_list: ...;
}, ZodTypeAny, "passthrough">>>>;
rule1: ZodOptional<ZodNullable<ZodObject<{
action: ZodOptional<...>;
response_page: ZodOptional<...>;
show_rsp_page: ZodOptional<...>;
}, "passthrough", ZodTypeAny, objectOutputType<{
action: ...;
response_page: ...;
show_rsp_page: ...;
}, ZodTypeAny, "passthrough">, objectInputType<{
action: ...;
response_page: ...;
show_rsp_page: ...;
}, ZodTypeAny, "passthrough">>>>;
rule2: ZodOptional<ZodNullable<ZodObject<{
action: ZodOptional<...>;
response_page: ZodOptional<...>;
show_rsp_page: ZodOptional<...>;
}, "passthrough", ZodTypeAny, objectOutputType<{
action: ...;
response_page: ...;
show_rsp_page: ...;
}, ZodTypeAny, "passthrough">, objectInputType<{
action: ...;
response_page: ...;
show_rsp_page: ...;
}, 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<ZodString>>;
data_profile_id: ZodOptional<ZodNullable<ZodNumber>>;
direction: ZodOptional<ZodNullable<ZodString>>;
file_based: ZodOptional<ZodNullable<ZodBoolean>>;
non_file_based: ZodOptional<ZodNullable<ZodBoolean>>;
log_severity: ZodOptional<ZodNullable<ZodString>>;
scan_type: ZodOptional<ZodNullable<ZodEnum<[..., ...]>>>;
is_end_user_coaching_enabled: ZodOptional<ZodNullable<ZodBoolean>>;
is_granular_profile: ZodOptional<ZodNullable<ZodBoolean>>;
is_parent_managed: ZodOptional<ZodNullable<ZodBoolean>>;
euc_template_id: ZodOptional<ZodNullable<ZodString>>;
version: ZodOptional<ZodNullable<ZodNumber>>;
file_type: ZodOptional<ZodNullable<ZodArray<ZodString, "many">>>;
audit_metadata: ZodOptional<ZodNullable<ZodObject<{
created_at: ...;
created_by: ...;
updated_at: ...;
updated_by: ...;
}, "passthrough", ZodTypeAny, objectOutputType<..., ..., ...>, objectInputType<..., ..., ...>>>>;
criteria_details: ZodOptional<ZodNullable<ZodArray<ZodObject<..., ..., ..., ..., ...>, "many">>>;
exception_rules: ZodOptional<ZodNullable<ZodArray<ZodObject<..., ..., ..., ..., ...>, "many">>>;
exclusions: ZodOptional<ZodNullable<ZodObject<{
app_exclusion_list: ...;
url_exclusion_list: ...;
exclusion_list: ...;
}, "passthrough", ZodTypeAny, objectOutputType<..., ..., ...>, objectInputType<..., ..., ...>>>>;
rule1: ZodOptional<ZodNullable<ZodObject<{
action: ...;
response_page: ...;
show_rsp_page: ...;
}, "passthrough", ZodTypeAny, objectOutputType<..., ..., ...>, objectInputType<..., ..., ...>>>>;
rule2: ZodOptional<ZodNullable<ZodObject<{
action: ...;
response_page: ...;
show_rsp_page: ...;
}, "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<ZodString>>;
data_profile_id: ZodOptional<ZodNullable<ZodNumber>>;
direction: ZodOptional<ZodNullable<ZodString>>;
file_based: ZodOptional<ZodNullable<ZodBoolean>>;
non_file_based: ZodOptional<ZodNullable<ZodBoolean>>;
log_severity: ZodOptional<ZodNullable<ZodString>>;
scan_type: ZodOptional<ZodNullable<ZodEnum<[..., ...]>>>;
is_end_user_coaching_enabled: ZodOptional<ZodNullable<ZodBoolean>>;
is_granular_profile: ZodOptional<ZodNullable<ZodBoolean>>;
is_parent_managed: ZodOptional<ZodNullable<ZodBoolean>>;
euc_template_id: ZodOptional<ZodNullable<ZodString>>;
version: ZodOptional<ZodNullable<ZodNumber>>;
file_type: ZodOptional<ZodNullable<ZodArray<ZodString, "many">>>;
audit_metadata: ZodOptional<ZodNullable<ZodObject<{
created_at: ...;
created_by: ...;
updated_at: ...;
updated_by: ...;
}, "passthrough", ZodTypeAny, objectOutputType<..., ..., ...>, objectInputType<..., ..., ...>>>>;
criteria_details: ZodOptional<ZodNullable<ZodArray<ZodObject<..., ..., ..., ..., ...>, "many">>>;
exception_rules: ZodOptional<ZodNullable<ZodArray<ZodObject<..., ..., ..., ..., ...>, "many">>>;
exclusions: ZodOptional<ZodNullable<ZodObject<{
app_exclusion_list: ...;
url_exclusion_list: ...;
exclusion_list: ...;
}, "passthrough", ZodTypeAny, objectOutputType<..., ..., ...>, objectInputType<..., ..., ...>>>>;
rule1: ZodOptional<ZodNullable<ZodObject<{
action: ...;
response_page: ...;
show_rsp_page: ...;
}, "passthrough", ZodTypeAny, objectOutputType<..., ..., ...>, objectInputType<..., ..., ...>>>>;
rule2: ZodOptional<ZodNullable<ZodObject<{
action: ...;
response_page: ...;
show_rsp_page: ...;
}, "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.dataFilteringProfiles.list({ size: 5, status: 'enabled' });
// page =>
// {
// content: [{ id: 'dfp-1', name: 'Finance', file_based: true, non_file_based: false }],
// totalElements: 1, totalPages: 1, number: 0, size: 20, first: true, last: true
// }
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<ZodString>>;
data_profile_id: ZodOptional<ZodNullable<ZodNumber>>;
direction: ZodOptional<ZodNullable<ZodString>>;
file_based: ZodOptional<ZodNullable<ZodBoolean>>;
non_file_based: ZodOptional<ZodNullable<ZodBoolean>>;
log_severity: ZodOptional<ZodNullable<ZodString>>;
scan_type: ZodOptional<ZodNullable<ZodEnum<["include", "exclude"]>>>;
is_end_user_coaching_enabled: ZodOptional<ZodNullable<ZodBoolean>>;
is_granular_profile: ZodOptional<ZodNullable<ZodBoolean>>;
is_parent_managed: ZodOptional<ZodNullable<ZodBoolean>>;
euc_template_id: ZodOptional<ZodNullable<ZodString>>;
version: ZodOptional<ZodNullable<ZodNumber>>;
file_type: ZodOptional<ZodNullable<ZodArray<ZodString, "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">>>>;
criteria_details: ZodOptional<ZodNullable<ZodArray<ZodObject<{
action: ZodOptional<ZodNullable<ZodString>>;
dataProfileId: ZodOptional<ZodNullable<ZodNumber>>;
direction: ZodOptional<ZodNullable<ZodString>>;
euc_template_id: ZodOptional<ZodNullable<ZodString>>;
fileBased: ZodOptional<ZodNullable<ZodString>>;
fileTypes: ZodOptional<ZodNullable<ZodArray<..., ...>>>;
is_end_user_coaching_enabled: ZodOptional<ZodNullable<ZodBoolean>>;
logSeverity: ZodOptional<ZodNullable<ZodString>>;
nonFileBased: ZodOptional<ZodNullable<ZodString>>;
scanType: ZodOptional<ZodNullable<ZodString>>;
}, "passthrough", ZodTypeAny, objectOutputType<{
action: ZodOptional<ZodNullable<...>>;
dataProfileId: ZodOptional<ZodNullable<...>>;
direction: ZodOptional<ZodNullable<...>>;
euc_template_id: ZodOptional<ZodNullable<...>>;
fileBased: ZodOptional<ZodNullable<...>>;
fileTypes: ZodOptional<ZodNullable<...>>;
is_end_user_coaching_enabled: ZodOptional<ZodNullable<...>>;
logSeverity: ZodOptional<ZodNullable<...>>;
nonFileBased: ZodOptional<ZodNullable<...>>;
scanType: ZodOptional<ZodNullable<...>>;
}, ZodTypeAny, "passthrough">, objectInputType<{
action: ZodOptional<ZodNullable<...>>;
dataProfileId: ZodOptional<ZodNullable<...>>;
direction: ZodOptional<ZodNullable<...>>;
euc_template_id: ZodOptional<ZodNullable<...>>;
fileBased: ZodOptional<ZodNullable<...>>;
fileTypes: ZodOptional<ZodNullable<...>>;
is_end_user_coaching_enabled: ZodOptional<ZodNullable<...>>;
logSeverity: ZodOptional<ZodNullable<...>>;
nonFileBased: ZodOptional<ZodNullable<...>>;
scanType: ZodOptional<ZodNullable<...>>;
}, ZodTypeAny, "passthrough">>, "many">>>;
exception_rules: ZodOptional<ZodNullable<ZodArray<ZodObject<{
id: ZodOptional<ZodNullable<ZodString>>;
action: ZodOptional<ZodNullable<ZodEnum<...>>>;
log_severity: ZodOptional<ZodNullable<ZodEnum<...>>>;
data_profile_ids: ZodOptional<ZodNullable<ZodArray<..., ...>>>;
destination_attributes: ZodOptional<ZodNullable<ZodObject<..., ..., ..., ..., ...>>>;
source_attributes: ZodOptional<ZodNullable<ZodObject<..., ..., ..., ..., ...>>>;
}, "passthrough", ZodTypeAny, objectOutputType<{
id: ZodOptional<ZodNullable<...>>;
action: ZodOptional<ZodNullable<...>>;
log_severity: ZodOptional<ZodNullable<...>>;
data_profile_ids: ZodOptional<ZodNullable<...>>;
destination_attributes: ZodOptional<ZodNullable<...>>;
source_attributes: ZodOptional<ZodNullable<...>>;
}, ZodTypeAny, "passthrough">, objectInputType<{
id: ZodOptional<ZodNullable<...>>;
action: ZodOptional<ZodNullable<...>>;
log_severity: ZodOptional<ZodNullable<...>>;
data_profile_ids: ZodOptional<ZodNullable<...>>;
destination_attributes: ZodOptional<ZodNullable<...>>;
source_attributes: ZodOptional<ZodNullable<...>>;
}, ZodTypeAny, "passthrough">>, "many">>>;
exclusions: ZodOptional<ZodNullable<ZodObject<{
app_exclusion_list: ZodOptional<ZodNullable<ZodArray<ZodObject<..., ..., ..., ..., ...>, "many">>>;
url_exclusion_list: ZodOptional<ZodNullable<ZodArray<ZodObject<..., ..., ..., ..., ...>, "many">>>;
exclusion_list: ZodOptional<ZodNullable<ZodRecord<ZodString, ZodArray<..., ...>>>>;
}, "passthrough", ZodTypeAny, objectOutputType<{
app_exclusion_list: ZodOptional<ZodNullable<ZodArray<..., ...>>>;
url_exclusion_list: ZodOptional<ZodNullable<ZodArray<..., ...>>>;
exclusion_list: ZodOptional<ZodNullable<ZodRecord<..., ...>>>;
}, ZodTypeAny, "passthrough">, objectInputType<{
app_exclusion_list: ZodOptional<ZodNullable<ZodArray<..., ...>>>;
url_exclusion_list: ZodOptional<ZodNullable<ZodArray<..., ...>>>;
exclusion_list: ZodOptional<ZodNullable<ZodRecord<..., ...>>>;
}, ZodTypeAny, "passthrough">>>>;
rule1: ZodOptional<ZodNullable<ZodObject<{
action: ZodOptional<ZodNullable<ZodString>>;
response_page: ZodOptional<ZodNullable<ZodString>>;
show_rsp_page: ZodOptional<ZodNullable<ZodString>>;
}, "passthrough", ZodTypeAny, objectOutputType<{
action: ZodOptional<ZodNullable<ZodString>>;
response_page: ZodOptional<ZodNullable<ZodString>>;
show_rsp_page: ZodOptional<ZodNullable<ZodString>>;
}, ZodTypeAny, "passthrough">, objectInputType<{
action: ZodOptional<ZodNullable<ZodString>>;
response_page: ZodOptional<ZodNullable<ZodString>>;
show_rsp_page: ZodOptional<ZodNullable<ZodString>>;
}, ZodTypeAny, "passthrough">>>>;
rule2: ZodOptional<ZodNullable<ZodObject<{
action: ZodOptional<ZodNullable<ZodString>>;
response_page: ZodOptional<ZodNullable<ZodString>>;
show_rsp_page: ZodOptional<ZodNullable<ZodString>>;
}, "passthrough", ZodTypeAny, objectOutputType<{
action: ZodOptional<ZodNullable<ZodString>>;
response_page: ZodOptional<ZodNullable<ZodString>>;
show_rsp_page: ZodOptional<ZodNullable<ZodString>>;
}, ZodTypeAny, "passthrough">, objectInputType<{
action: ZodOptional<ZodNullable<ZodString>>;
response_page: ZodOptional<ZodNullable<ZodString>>;
show_rsp_page: ZodOptional<ZodNullable<ZodString>>;
}, ZodTypeAny, "passthrough">>>>;
}, ZodTypeAny, "passthrough">>;
Defined in: src/management/dlp/data-filtering-profiles.ts:101
Get a single data filtering profile by resource ID.
Parameters
| Parameter | Type |
|---|---|
resourceId | string |
Returns
Promise<objectOutputType<{
id: ZodOptional<ZodNullable<ZodString>>;
name: ZodOptional<ZodNullable<ZodString>>;
description: ZodOptional<ZodNullable<ZodString>>;
tenant_id: ZodOptional<ZodNullable<ZodString>>;
type: ZodOptional<ZodNullable<ZodString>>;
data_profile_id: ZodOptional<ZodNullable<ZodNumber>>;
direction: ZodOptional<ZodNullable<ZodString>>;
file_based: ZodOptional<ZodNullable<ZodBoolean>>;
non_file_based: ZodOptional<ZodNullable<ZodBoolean>>;
log_severity: ZodOptional<ZodNullable<ZodString>>;
scan_type: ZodOptional<ZodNullable<ZodEnum<["include", "exclude"]>>>;
is_end_user_coaching_enabled: ZodOptional<ZodNullable<ZodBoolean>>;
is_granular_profile: ZodOptional<ZodNullable<ZodBoolean>>;
is_parent_managed: ZodOptional<ZodNullable<ZodBoolean>>;
euc_template_id: ZodOptional<ZodNullable<ZodString>>;
version: ZodOptional<ZodNullable<ZodNumber>>;
file_type: ZodOptional<ZodNullable<ZodArray<ZodString, "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">>>>;
criteria_details: ZodOptional<ZodNullable<ZodArray<ZodObject<{
action: ZodOptional<ZodNullable<ZodString>>;
dataProfileId: ZodOptional<ZodNullable<ZodNumber>>;
direction: ZodOptional<ZodNullable<ZodString>>;
euc_template_id: ZodOptional<ZodNullable<ZodString>>;
fileBased: ZodOptional<ZodNullable<ZodString>>;
fileTypes: ZodOptional<ZodNullable<ZodArray<..., ...>>>;
is_end_user_coaching_enabled: ZodOptional<ZodNullable<ZodBoolean>>;
logSeverity: ZodOptional<ZodNullable<ZodString>>;
nonFileBased: ZodOptional<ZodNullable<ZodString>>;
scanType: ZodOptional<ZodNullable<ZodString>>;
}, "passthrough", ZodTypeAny, objectOutputType<{
action: ZodOptional<ZodNullable<...>>;
dataProfileId: ZodOptional<ZodNullable<...>>;
direction: ZodOptional<ZodNullable<...>>;
euc_template_id: ZodOptional<ZodNullable<...>>;
fileBased: ZodOptional<ZodNullable<...>>;
fileTypes: ZodOptional<ZodNullable<...>>;
is_end_user_coaching_enabled: ZodOptional<ZodNullable<...>>;
logSeverity: ZodOptional<ZodNullable<...>>;
nonFileBased: ZodOptional<ZodNullable<...>>;
scanType: ZodOptional<ZodNullable<...>>;
}, ZodTypeAny, "passthrough">, objectInputType<{
action: ZodOptional<ZodNullable<...>>;
dataProfileId: ZodOptional<ZodNullable<...>>;
direction: ZodOptional<ZodNullable<...>>;
euc_template_id: ZodOptional<ZodNullable<...>>;
fileBased: ZodOptional<ZodNullable<...>>;
fileTypes: ZodOptional<ZodNullable<...>>;
is_end_user_coaching_enabled: ZodOptional<ZodNullable<...>>;
logSeverity: ZodOptional<ZodNullable<...>>;
nonFileBased: ZodOptional<ZodNullable<...>>;
scanType: ZodOptional<ZodNullable<...>>;
}, ZodTypeAny, "passthrough">>, "many">>>;
exception_rules: ZodOptional<ZodNullable<ZodArray<ZodObject<{
id: ZodOptional<ZodNullable<ZodString>>;
action: ZodOptional<ZodNullable<ZodEnum<...>>>;
log_severity: ZodOptional<ZodNullable<ZodEnum<...>>>;
data_profile_ids: ZodOptional<ZodNullable<ZodArray<..., ...>>>;
destination_attributes: ZodOptional<ZodNullable<ZodObject<..., ..., ..., ..., ...>>>;
source_attributes: ZodOptional<ZodNullable<ZodObject<..., ..., ..., ..., ...>>>;
}, "passthrough", ZodTypeAny, objectOutputType<{
id: ZodOptional<ZodNullable<...>>;
action: ZodOptional<ZodNullable<...>>;
log_severity: ZodOptional<ZodNullable<...>>;
data_profile_ids: ZodOptional<ZodNullable<...>>;
destination_attributes: ZodOptional<ZodNullable<...>>;
source_attributes: ZodOptional<ZodNullable<...>>;
}, ZodTypeAny, "passthrough">, objectInputType<{
id: ZodOptional<ZodNullable<...>>;
action: ZodOptional<ZodNullable<...>>;
log_severity: ZodOptional<ZodNullable<...>>;
data_profile_ids: ZodOptional<ZodNullable<...>>;
destination_attributes: ZodOptional<ZodNullable<...>>;
source_attributes: ZodOptional<ZodNullable<...>>;
}, ZodTypeAny, "passthrough">>, "many">>>;
exclusions: ZodOptional<ZodNullable<ZodObject<{
app_exclusion_list: ZodOptional<ZodNullable<ZodArray<ZodObject<..., ..., ..., ..., ...>, "many">>>;
url_exclusion_list: ZodOptional<ZodNullable<ZodArray<ZodObject<..., ..., ..., ..., ...>, "many">>>;
exclusion_list: ZodOptional<ZodNullable<ZodRecord<ZodString, ZodArray<..., ...>>>>;
}, "passthrough", ZodTypeAny, objectOutputType<{
app_exclusion_list: ZodOptional<ZodNullable<ZodArray<..., ...>>>;
url_exclusion_list: ZodOptional<ZodNullable<ZodArray<..., ...>>>;
exclusion_list: ZodOptional<ZodNullable<ZodRecord<..., ...>>>;
}, ZodTypeAny, "passthrough">, objectInputType<{
app_exclusion_list: ZodOptional<ZodNullable<ZodArray<..., ...>>>;
url_exclusion_list: ZodOptional<ZodNullable<ZodArray<..., ...>>>;
exclusion_list: ZodOptional<ZodNullable<ZodRecord<..., ...>>>;
}, ZodTypeAny, "passthrough">>>>;
rule1: ZodOptional<ZodNullable<ZodObject<{
action: ZodOptional<ZodNullable<ZodString>>;
response_page: ZodOptional<ZodNullable<ZodString>>;
show_rsp_page: ZodOptional<ZodNullable<ZodString>>;
}, "passthrough", ZodTypeAny, objectOutputType<{
action: ZodOptional<ZodNullable<ZodString>>;
response_page: ZodOptional<ZodNullable<ZodString>>;
show_rsp_page: ZodOptional<ZodNullable<ZodString>>;
}, ZodTypeAny, "passthrough">, objectInputType<{
action: ZodOptional<ZodNullable<ZodString>>;
response_page: ZodOptional<ZodNullable<ZodString>>;
show_rsp_page: ZodOptional<ZodNullable<ZodString>>;
}, ZodTypeAny, "passthrough">>>>;
rule2: ZodOptional<ZodNullable<ZodObject<{
action: ZodOptional<ZodNullable<ZodString>>;
response_page: ZodOptional<ZodNullable<ZodString>>;
show_rsp_page: ZodOptional<ZodNullable<ZodString>>;
}, "passthrough", ZodTypeAny, objectOutputType<{
action: ZodOptional<ZodNullable<ZodString>>;
response_page: ZodOptional<ZodNullable<ZodString>>;
show_rsp_page: ZodOptional<ZodNullable<ZodString>>;
}, ZodTypeAny, "passthrough">, objectInputType<{
action: ZodOptional<ZodNullable<ZodString>>;
response_page: ZodOptional<ZodNullable<ZodString>>;
show_rsp_page: ZodOptional<ZodNullable<ZodString>>;
}, ZodTypeAny, "passthrough">>>>;
}, ZodTypeAny, "passthrough">>
Example
import { ManagementClient } from '@cdot65/prisma-airs-sdk';
const mgmt = new ManagementClient();
const profile = await mgmt.dlp.dataFilteringProfiles.get('dfp-1');
// profile =>
// { id: 'dfp-1', name: 'Finance', file_based: true, non_file_based: false }
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<ZodString>>;
data_profile_id: ZodOptional<ZodNullable<ZodNumber>>;
direction: ZodOptional<ZodNullable<ZodString>>;
file_based: ZodOptional<ZodNullable<ZodBoolean>>;
non_file_based: ZodOptional<ZodNullable<ZodBoolean>>;
log_severity: ZodOptional<ZodNullable<ZodString>>;
scan_type: ZodOptional<ZodNullable<ZodEnum<["include", "exclude"]>>>;
is_end_user_coaching_enabled: ZodOptional<ZodNullable<ZodBoolean>>;
is_granular_profile: ZodOptional<ZodNullable<ZodBoolean>>;
is_parent_managed: ZodOptional<ZodNullable<ZodBoolean>>;
euc_template_id: ZodOptional<ZodNullable<ZodString>>;
version: ZodOptional<ZodNullable<ZodNumber>>;
file_type: ZodOptional<ZodNullable<ZodArray<ZodString, "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">>>>;
criteria_details: ZodOptional<ZodNullable<ZodArray<ZodObject<{
action: ZodOptional<ZodNullable<ZodString>>;
dataProfileId: ZodOptional<ZodNullable<ZodNumber>>;
direction: ZodOptional<ZodNullable<ZodString>>;
euc_template_id: ZodOptional<ZodNullable<ZodString>>;
fileBased: ZodOptional<ZodNullable<ZodString>>;
fileTypes: ZodOptional<ZodNullable<ZodArray<..., ...>>>;
is_end_user_coaching_enabled: ZodOptional<ZodNullable<ZodBoolean>>;
logSeverity: ZodOptional<ZodNullable<ZodString>>;
nonFileBased: ZodOptional<ZodNullable<ZodString>>;
scanType: ZodOptional<ZodNullable<ZodString>>;
}, "passthrough", ZodTypeAny, objectOutputType<{
action: ZodOptional<ZodNullable<...>>;
dataProfileId: ZodOptional<ZodNullable<...>>;
direction: ZodOptional<ZodNullable<...>>;
euc_template_id: ZodOptional<ZodNullable<...>>;
fileBased: ZodOptional<ZodNullable<...>>;
fileTypes: ZodOptional<ZodNullable<...>>;
is_end_user_coaching_enabled: ZodOptional<ZodNullable<...>>;
logSeverity: ZodOptional<ZodNullable<...>>;
nonFileBased: ZodOptional<ZodNullable<...>>;
scanType: ZodOptional<ZodNullable<...>>;
}, ZodTypeAny, "passthrough">, objectInputType<{
action: ZodOptional<ZodNullable<...>>;
dataProfileId: ZodOptional<ZodNullable<...>>;
direction: ZodOptional<ZodNullable<...>>;
euc_template_id: ZodOptional<ZodNullable<...>>;
fileBased: ZodOptional<ZodNullable<...>>;
fileTypes: ZodOptional<ZodNullable<...>>;
is_end_user_coaching_enabled: ZodOptional<ZodNullable<...>>;
logSeverity: ZodOptional<ZodNullable<...>>;
nonFileBased: ZodOptional<ZodNullable<...>>;
scanType: ZodOptional<ZodNullable<...>>;
}, ZodTypeAny, "passthrough">>, "many">>>;
exception_rules: ZodOptional<ZodNullable<ZodArray<ZodObject<{
id: ZodOptional<ZodNullable<ZodString>>;
action: ZodOptional<ZodNullable<ZodEnum<...>>>;
log_severity: ZodOptional<ZodNullable<ZodEnum<...>>>;
data_profile_ids: ZodOptional<ZodNullable<ZodArray<..., ...>>>;
destination_attributes: ZodOptional<ZodNullable<ZodObject<..., ..., ..., ..., ...>>>;
source_attributes: ZodOptional<ZodNullable<ZodObject<..., ..., ..., ..., ...>>>;
}, "passthrough", ZodTypeAny, objectOutputType<{
id: ZodOptional<ZodNullable<...>>;
action: ZodOptional<ZodNullable<...>>;
log_severity: ZodOptional<ZodNullable<...>>;
data_profile_ids: ZodOptional<ZodNullable<...>>;
destination_attributes: ZodOptional<ZodNullable<...>>;
source_attributes: ZodOptional<ZodNullable<...>>;
}, ZodTypeAny, "passthrough">, objectInputType<{
id: ZodOptional<ZodNullable<...>>;
action: ZodOptional<ZodNullable<...>>;
log_severity: ZodOptional<ZodNullable<...>>;
data_profile_ids: ZodOptional<ZodNullable<...>>;
destination_attributes: ZodOptional<ZodNullable<...>>;
source_attributes: ZodOptional<ZodNullable<...>>;
}, ZodTypeAny, "passthrough">>, "many">>>;
exclusions: ZodOptional<ZodNullable<ZodObject<{
app_exclusion_list: ZodOptional<ZodNullable<ZodArray<ZodObject<..., ..., ..., ..., ...>, "many">>>;
url_exclusion_list: ZodOptional<ZodNullable<ZodArray<ZodObject<..., ..., ..., ..., ...>, "many">>>;
exclusion_list: ZodOptional<ZodNullable<ZodRecord<ZodString, ZodArray<..., ...>>>>;
}, "passthrough", ZodTypeAny, objectOutputType<{
app_exclusion_list: ZodOptional<ZodNullable<ZodArray<..., ...>>>;
url_exclusion_list: ZodOptional<ZodNullable<ZodArray<..., ...>>>;
exclusion_list: ZodOptional<ZodNullable<ZodRecord<..., ...>>>;
}, ZodTypeAny, "passthrough">, objectInputType<{
app_exclusion_list: ZodOptional<ZodNullable<ZodArray<..., ...>>>;
url_exclusion_list: ZodOptional<ZodNullable<ZodArray<..., ...>>>;
exclusion_list: ZodOptional<ZodNullable<ZodRecord<..., ...>>>;
}, ZodTypeAny, "passthrough">>>>;
rule1: ZodOptional<ZodNullable<ZodObject<{
action: ZodOptional<ZodNullable<ZodString>>;
response_page: ZodOptional<ZodNullable<ZodString>>;
show_rsp_page: ZodOptional<ZodNullable<ZodString>>;
}, "passthrough", ZodTypeAny, objectOutputType<{
action: ZodOptional<ZodNullable<ZodString>>;
response_page: ZodOptional<ZodNullable<ZodString>>;
show_rsp_page: ZodOptional<ZodNullable<ZodString>>;
}, ZodTypeAny, "passthrough">, objectInputType<{
action: ZodOptional<ZodNullable<ZodString>>;
response_page: ZodOptional<ZodNullable<ZodString>>;
show_rsp_page: ZodOptional<ZodNullable<ZodString>>;
}, ZodTypeAny, "passthrough">>>>;
rule2: ZodOptional<ZodNullable<ZodObject<{
action: ZodOptional<ZodNullable<ZodString>>;
response_page: ZodOptional<ZodNullable<ZodString>>;
show_rsp_page: ZodOptional<ZodNullable<ZodString>>;
}, "passthrough", ZodTypeAny, objectOutputType<{
action: ZodOptional<ZodNullable<ZodString>>;
response_page: ZodOptional<ZodNullable<ZodString>>;
show_rsp_page: ZodOptional<ZodNullable<ZodString>>;
}, ZodTypeAny, "passthrough">, objectInputType<{
action: ZodOptional<ZodNullable<ZodString>>;
response_page: ZodOptional<ZodNullable<ZodString>>;
show_rsp_page: ZodOptional<ZodNullable<ZodString>>;
}, ZodTypeAny, "passthrough">>>>;
}, ZodTypeAny, "passthrough">>;
Defined in: src/management/dlp/data-filtering-profiles.ts:129
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
Promise<objectOutputType<{
id: ZodOptional<ZodNullable<ZodString>>;
name: ZodOptional<ZodNullable<ZodString>>;
description: ZodOptional<ZodNullable<ZodString>>;
tenant_id: ZodOptional<ZodNullable<ZodString>>;
type: ZodOptional<ZodNullable<ZodString>>;
data_profile_id: ZodOptional<ZodNullable<ZodNumber>>;
direction: ZodOptional<ZodNullable<ZodString>>;
file_based: ZodOptional<ZodNullable<ZodBoolean>>;
non_file_based: ZodOptional<ZodNullable<ZodBoolean>>;
log_severity: ZodOptional<ZodNullable<ZodString>>;
scan_type: ZodOptional<ZodNullable<ZodEnum<["include", "exclude"]>>>;
is_end_user_coaching_enabled: ZodOptional<ZodNullable<ZodBoolean>>;
is_granular_profile: ZodOptional<ZodNullable<ZodBoolean>>;
is_parent_managed: ZodOptional<ZodNullable<ZodBoolean>>;
euc_template_id: ZodOptional<ZodNullable<ZodString>>;
version: ZodOptional<ZodNullable<ZodNumber>>;
file_type: ZodOptional<ZodNullable<ZodArray<ZodString, "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">>>>;
criteria_details: ZodOptional<ZodNullable<ZodArray<ZodObject<{
action: ZodOptional<ZodNullable<ZodString>>;
dataProfileId: ZodOptional<ZodNullable<ZodNumber>>;
direction: ZodOptional<ZodNullable<ZodString>>;
euc_template_id: ZodOptional<ZodNullable<ZodString>>;
fileBased: ZodOptional<ZodNullable<ZodString>>;
fileTypes: ZodOptional<ZodNullable<ZodArray<..., ...>>>;
is_end_user_coaching_enabled: ZodOptional<ZodNullable<ZodBoolean>>;
logSeverity: ZodOptional<ZodNullable<ZodString>>;
nonFileBased: ZodOptional<ZodNullable<ZodString>>;
scanType: ZodOptional<ZodNullable<ZodString>>;
}, "passthrough", ZodTypeAny, objectOutputType<{
action: ZodOptional<ZodNullable<...>>;
dataProfileId: ZodOptional<ZodNullable<...>>;
direction: ZodOptional<ZodNullable<...>>;
euc_template_id: ZodOptional<ZodNullable<...>>;
fileBased: ZodOptional<ZodNullable<...>>;
fileTypes: ZodOptional<ZodNullable<...>>;
is_end_user_coaching_enabled: ZodOptional<ZodNullable<...>>;
logSeverity: ZodOptional<ZodNullable<...>>;
nonFileBased: ZodOptional<ZodNullable<...>>;
scanType: ZodOptional<ZodNullable<...>>;
}, ZodTypeAny, "passthrough">, objectInputType<{
action: ZodOptional<ZodNullable<...>>;
dataProfileId: ZodOptional<ZodNullable<...>>;
direction: ZodOptional<ZodNullable<...>>;
euc_template_id: ZodOptional<ZodNullable<...>>;
fileBased: ZodOptional<ZodNullable<...>>;
fileTypes: ZodOptional<ZodNullable<...>>;
is_end_user_coaching_enabled: ZodOptional<ZodNullable<...>>;
logSeverity: ZodOptional<ZodNullable<...>>;
nonFileBased: ZodOptional<ZodNullable<...>>;
scanType: ZodOptional<ZodNullable<...>>;
}, ZodTypeAny, "passthrough">>, "many">>>;
exception_rules: ZodOptional<ZodNullable<ZodArray<ZodObject<{
id: ZodOptional<ZodNullable<ZodString>>;
action: ZodOptional<ZodNullable<ZodEnum<...>>>;
log_severity: ZodOptional<ZodNullable<ZodEnum<...>>>;
data_profile_ids: ZodOptional<ZodNullable<ZodArray<..., ...>>>;
destination_attributes: ZodOptional<ZodNullable<ZodObject<..., ..., ..., ..., ...>>>;
source_attributes: ZodOptional<ZodNullable<ZodObject<..., ..., ..., ..., ...>>>;
}, "passthrough", ZodTypeAny, objectOutputType<{
id: ZodOptional<ZodNullable<...>>;
action: ZodOptional<ZodNullable<...>>;
log_severity: ZodOptional<ZodNullable<...>>;
data_profile_ids: ZodOptional<ZodNullable<...>>;
destination_attributes: ZodOptional<ZodNullable<...>>;
source_attributes: ZodOptional<ZodNullable<...>>;
}, ZodTypeAny, "passthrough">, objectInputType<{
id: ZodOptional<ZodNullable<...>>;
action: ZodOptional<ZodNullable<...>>;
log_severity: ZodOptional<ZodNullable<...>>;
data_profile_ids: ZodOptional<ZodNullable<...>>;
destination_attributes: ZodOptional<ZodNullable<...>>;
source_attributes: ZodOptional<ZodNullable<...>>;
}, ZodTypeAny, "passthrough">>, "many">>>;
exclusions: ZodOptional<ZodNullable<ZodObject<{
app_exclusion_list: ZodOptional<ZodNullable<ZodArray<ZodObject<..., ..., ..., ..., ...>, "many">>>;
url_exclusion_list: ZodOptional<ZodNullable<ZodArray<ZodObject<..., ..., ..., ..., ...>, "many">>>;
exclusion_list: ZodOptional<ZodNullable<ZodRecord<ZodString, ZodArray<..., ...>>>>;
}, "passthrough", ZodTypeAny, objectOutputType<{
app_exclusion_list: ZodOptional<ZodNullable<ZodArray<..., ...>>>;
url_exclusion_list: ZodOptional<ZodNullable<ZodArray<..., ...>>>;
exclusion_list: ZodOptional<ZodNullable<ZodRecord<..., ...>>>;
}, ZodTypeAny, "passthrough">, objectInputType<{
app_exclusion_list: ZodOptional<ZodNullable<ZodArray<..., ...>>>;
url_exclusion_list: ZodOptional<ZodNullable<ZodArray<..., ...>>>;
exclusion_list: ZodOptional<ZodNullable<ZodRecord<..., ...>>>;
}, ZodTypeAny, "passthrough">>>>;
rule1: ZodOptional<ZodNullable<ZodObject<{
action: ZodOptional<ZodNullable<ZodString>>;
response_page: ZodOptional<ZodNullable<ZodString>>;
show_rsp_page: ZodOptional<ZodNullable<ZodString>>;
}, "passthrough", ZodTypeAny, objectOutputType<{
action: ZodOptional<ZodNullable<ZodString>>;
response_page: ZodOptional<ZodNullable<ZodString>>;
show_rsp_page: ZodOptional<ZodNullable<ZodString>>;
}, ZodTypeAny, "passthrough">, objectInputType<{
action: ZodOptional<ZodNullable<ZodString>>;
response_page: ZodOptional<ZodNullable<ZodString>>;
show_rsp_page: ZodOptional<ZodNullable<ZodString>>;
}, ZodTypeAny, "passthrough">>>>;
rule2: ZodOptional<ZodNullable<ZodObject<{
action: ZodOptional<ZodNullable<ZodString>>;
response_page: ZodOptional<ZodNullable<ZodString>>;
show_rsp_page: ZodOptional<ZodNullable<ZodString>>;
}, "passthrough", ZodTypeAny, objectOutputType<{
action: ZodOptional<ZodNullable<ZodString>>;
response_page: ZodOptional<ZodNullable<ZodString>>;
show_rsp_page: ZodOptional<ZodNullable<ZodString>>;
}, ZodTypeAny, "passthrough">, objectInputType<{
action: ZodOptional<ZodNullable<ZodString>>;
response_page: ZodOptional<ZodNullable<ZodString>>;
show_rsp_page: ZodOptional<ZodNullable<ZodString>>;
}, ZodTypeAny, "passthrough">>>>;
}, ZodTypeAny, "passthrough">>
Example
import { ManagementClient } from '@cdot65/prisma-airs-sdk';
const mgmt = new ManagementClient();
const updated = await mgmt.dlp.dataFilteringProfiles.replace('dfp-1', {
file_based: true,
non_file_based: false,
description: 'Finance — updated',
});
// updated =>
// { id: 'dfp-1', name: 'Finance', file_based: true, non_file_based: false }