API Reference

Zero Trust

DLP

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Email

EmailAccount Mapping

Get mapping

client.zeroTrust.dlp.email.accountMapping.get(AccountMappingGetParams { account_id } params, RequestOptionsoptions?): AccountMappingGetResponse { addin_identifier_token, auth_requirements }

GET/accounts/{account_id}/dlp/email/account_mapping

Create mapping

client.zeroTrust.dlp.email.accountMapping.create(AccountMappingCreateParams { account_id, auth_requirements } params, RequestOptionsoptions?): AccountMappingCreateResponse { addin_identifier_token, auth_requirements }

POST/accounts/{account_id}/dlp/email/account_mapping

ModelsExpand Collapse

AccountMappingGetResponse { addin_identifier_token, auth_requirements }

addin_identifier_token: string

formatuuid

auth_requirements: UnionMember0 { allowed_microsoft_organizations, type } | Type { type }

One of the following:

UnionMember0 { allowed_microsoft_organizations, type }

allowed_microsoft_organizations: Array<string>

type: "Org"

Type { type }

type: "NoAuth"

AccountMappingCreateResponse { addin_identifier_token, auth_requirements }

addin_identifier_token: string

formatuuid

auth_requirements: UnionMember0 { allowed_microsoft_organizations, type } | Type { type }

One of the following:

UnionMember0 { allowed_microsoft_organizations, type }

allowed_microsoft_organizations: Array<string>

type: "Org"

Type { type }

type: "NoAuth"

EmailRules

List all email scanner rules

client.zeroTrust.dlp.email.rules.list(RuleListParams { account_id } params, RequestOptionsoptions?): SinglePage<RuleListResponse { action, conditions, created_at, 6 more } >

GET/accounts/{account_id}/dlp/email/rules

Get an email scanner rule

client.zeroTrust.dlp.email.rules.get(stringruleId, RuleGetParams { account_id } params, RequestOptionsoptions?): RuleGetResponse { action, conditions, created_at, 6 more }

GET/accounts/{account_id}/dlp/email/rules/{rule_id}

Create email scanner rule

client.zeroTrust.dlp.email.rules.create(RuleCreateParams { account_id, action, conditions, 3 more } params, RequestOptionsoptions?): RuleCreateResponse { action, conditions, created_at, 6 more }

POST/accounts/{account_id}/dlp/email/rules

Update email scanner rule

client.zeroTrust.dlp.email.rules.update(stringruleId, RuleUpdateParams { account_id, action, conditions, 3 more } params, RequestOptionsoptions?): RuleUpdateResponse { action, conditions, created_at, 6 more }

PUT/accounts/{account_id}/dlp/email/rules/{rule_id}

Delete email scanner rule

client.zeroTrust.dlp.email.rules.delete(stringruleId, RuleDeleteParams { account_id } params, RequestOptionsoptions?): RuleDeleteResponse { action, conditions, created_at, 6 more }

DELETE/accounts/{account_id}/dlp/email/rules/{rule_id}

Update email scanner rule priorities

client.zeroTrust.dlp.email.rules.bulkEdit(RuleBulkEditParams { account_id, new_priorities } params, RequestOptionsoptions?): RuleBulkEditResponse { action, conditions, created_at, 6 more }

PATCH/accounts/{account_id}/dlp/email/rules

ModelsExpand Collapse

RuleListResponse { action, conditions, created_at, 6 more }

action: Action { action, message }

action: "Block"

message?: string | null

conditions: Array<Condition>

Triggered if all conditions match.

operator: "InList" | "NotInList" | "MatchRegex" | "NotMatchRegex"

One of the following:

"InList"

"NotInList"

"MatchRegex"

"NotMatchRegex"

selector: "Recipients" | "Sender" | "DLPProfiles"

One of the following:

"Recipients"

"Sender"

"DLPProfiles"

value: Array<string> | string

One of the following:

Array<string>

string

created_at: string

formatdate-time

enabled: boolean

name: string

priority: number

formatint32

minimum0

rule_id: string

formatuuid

updated_at: string

formatdate-time

description?: string | null

RuleGetResponse { action, conditions, created_at, 6 more }

action: Action { action, message }

action: "Block"

message?: string | null

conditions: Array<Condition>

Triggered if all conditions match.

operator: "InList" | "NotInList" | "MatchRegex" | "NotMatchRegex"

One of the following:

"InList"

"NotInList"

"MatchRegex"

"NotMatchRegex"

selector: "Recipients" | "Sender" | "DLPProfiles"

One of the following:

"Recipients"

"Sender"

"DLPProfiles"

value: Array<string> | string

One of the following:

Array<string>

string

created_at: string

formatdate-time

enabled: boolean

name: string

priority: number

formatint32

minimum0

rule_id: string

formatuuid

updated_at: string

formatdate-time

description?: string | null

RuleCreateResponse { action, conditions, created_at, 6 more }

action: Action { action, message }

action: "Block"

message?: string | null

conditions: Array<Condition>

Triggered if all conditions match.

operator: "InList" | "NotInList" | "MatchRegex" | "NotMatchRegex"

One of the following:

"InList"

"NotInList"

"MatchRegex"

"NotMatchRegex"

selector: "Recipients" | "Sender" | "DLPProfiles"

One of the following:

"Recipients"

"Sender"

"DLPProfiles"

value: Array<string> | string

One of the following:

Array<string>

string

created_at: string

formatdate-time

enabled: boolean

name: string

priority: number

formatint32

minimum0

rule_id: string

formatuuid

updated_at: string

formatdate-time

description?: string | null

RuleUpdateResponse { action, conditions, created_at, 6 more }

action: Action { action, message }

action: "Block"

message?: string | null

conditions: Array<Condition>

Triggered if all conditions match.

operator: "InList" | "NotInList" | "MatchRegex" | "NotMatchRegex"

One of the following:

"InList"

"NotInList"

"MatchRegex"

"NotMatchRegex"

selector: "Recipients" | "Sender" | "DLPProfiles"

One of the following:

"Recipients"

"Sender"

"DLPProfiles"

value: Array<string> | string

One of the following:

Array<string>

string

created_at: string

formatdate-time

enabled: boolean

name: string

priority: number

formatint32

minimum0

rule_id: string

formatuuid

updated_at: string

formatdate-time

description?: string | null

RuleDeleteResponse { action, conditions, created_at, 6 more }

action: Action { action, message }

action: "Block"

message?: string | null

conditions: Array<Condition>

Triggered if all conditions match.

operator: "InList" | "NotInList" | "MatchRegex" | "NotMatchRegex"

One of the following:

"InList"

"NotInList"

"MatchRegex"

"NotMatchRegex"

selector: "Recipients" | "Sender" | "DLPProfiles"

One of the following:

"Recipients"

"Sender"

"DLPProfiles"

value: Array<string> | string

One of the following:

Array<string>

string

created_at: string

formatdate-time

enabled: boolean

name: string

priority: number

formatint32

minimum0

rule_id: string

formatuuid

updated_at: string

formatdate-time

description?: string | null

RuleBulkEditResponse { action, conditions, created_at, 6 more }

action: Action { action, message }

action: "Block"

message?: string | null

conditions: Array<Condition>

Triggered if all conditions match.

operator: "InList" | "NotInList" | "MatchRegex" | "NotMatchRegex"

One of the following:

"InList"

"NotInList"

"MatchRegex"

"NotMatchRegex"

selector: "Recipients" | "Sender" | "DLPProfiles"

One of the following:

"Recipients"

"Sender"

"DLPProfiles"

value: Array<string> | string

One of the following:

Array<string>

string

created_at: string

formatdate-time

enabled: boolean

name: string

priority: number

formatint32

minimum0

rule_id: string

formatuuid

updated_at: string

formatdate-time

description?: string | null