API Reference

Email Security

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Settings

SettingsAllow Policies

List email allow policies

client.emailSecurity.settings.allowPolicies.list(AllowPolicyListParams { account_id, direction, is_acceptable_sender, 9 more } params, RequestOptionsoptions?): V4PagePaginationArray<AllowPolicyListResponse { id, created_at, last_modified, 12 more } >

GET/accounts/{account_id}/email-security/settings/allow_policies

Get an email allow policy

client.emailSecurity.settings.allowPolicies.get(stringpolicyId, AllowPolicyGetParams { account_id } params, RequestOptionsoptions?): AllowPolicyGetResponse { id, created_at, last_modified, 12 more }

GET/accounts/{account_id}/email-security/settings/allow_policies/{policy_id}

Create email allow policy

client.emailSecurity.settings.allowPolicies.create(AllowPolicyCreateParams { account_id, is_acceptable_sender, is_exempt_recipient, 9 more } params, RequestOptionsoptions?): AllowPolicyCreateResponse { id, created_at, last_modified, 12 more }

POST/accounts/{account_id}/email-security/settings/allow_policies

Update an email allow policy

client.emailSecurity.settings.allowPolicies.edit(stringpolicyId, AllowPolicyEditParams { account_id, comments, is_acceptable_sender, 9 more } params, RequestOptionsoptions?): AllowPolicyEditResponse { id, created_at, last_modified, 12 more }

PATCH/accounts/{account_id}/email-security/settings/allow_policies/{policy_id}

Delete an email allow policy

client.emailSecurity.settings.allowPolicies.delete(stringpolicyId, AllowPolicyDeleteParams { account_id } params, RequestOptionsoptions?): AllowPolicyDeleteResponse { id }

DELETE/accounts/{account_id}/email-security/settings/allow_policies/{policy_id}

ModelsExpand Collapse

AllowPolicyListResponse { id, created_at, last_modified, 12 more }

An email allow policy

id: string

Allow policy identifier

formatuuid

created_at: string

formatdate-time

Deprecatedlast_modified: string

Deprecated, use modified_at instead. End of life: November 1, 2026.

formatdate-time

comments?: string | null

maxLength1024

is_acceptable_sender?: boolean

Messages from this sender will be exempted from Spam, Spoof and Bulk dispositions. Note - This will not exempt messages with Malicious or Suspicious dispositions.

is_exempt_recipient?: boolean

Messages to this recipient will bypass all detections

Deprecatedis_recipient?: boolean

Deprecated as of July 1, 2025. Use is_exempt_recipient instead. End of life: July 1, 2026.

is_regex?: boolean

Deprecatedis_sender?: boolean

Deprecated as of July 1, 2025. Use is_trusted_sender instead. End of life: July 1, 2026.

Deprecatedis_spoof?: boolean

Deprecated as of July 1, 2025. Use is_acceptable_sender instead. End of life: July 1, 2026.

is_trusted_sender?: boolean

Messages from this sender will bypass all detections and link following

modified_at?: string

formatdate-time

pattern?: string

maxLength1024

minLength1

pattern_type?: "EMAIL" | "DOMAIN" | "IP" | "UNKNOWN"

Type of pattern matching. Note: UNKNOWN is deprecated and cannot be used when creating or updating policies, but may be returned for existing entries.

One of the following:

"EMAIL"

"DOMAIN"

"IP"

"UNKNOWN"

verify_sender?: boolean

Enforce DMARC, SPF or DKIM authentication. When on, Email Security only honors policies that pass authentication.

AllowPolicyGetResponse { id, created_at, last_modified, 12 more }

An email allow policy

id: string

Allow policy identifier

formatuuid

created_at: string

formatdate-time

Deprecatedlast_modified: string

Deprecated, use modified_at instead. End of life: November 1, 2026.

formatdate-time

comments?: string | null

maxLength1024

is_acceptable_sender?: boolean

Messages from this sender will be exempted from Spam, Spoof and Bulk dispositions. Note - This will not exempt messages with Malicious or Suspicious dispositions.

is_exempt_recipient?: boolean

Messages to this recipient will bypass all detections

Deprecatedis_recipient?: boolean

Deprecated as of July 1, 2025. Use is_exempt_recipient instead. End of life: July 1, 2026.

is_regex?: boolean

Deprecatedis_sender?: boolean

Deprecated as of July 1, 2025. Use is_trusted_sender instead. End of life: July 1, 2026.

Deprecatedis_spoof?: boolean

Deprecated as of July 1, 2025. Use is_acceptable_sender instead. End of life: July 1, 2026.

is_trusted_sender?: boolean

Messages from this sender will bypass all detections and link following

modified_at?: string

formatdate-time

pattern?: string

maxLength1024

minLength1

pattern_type?: "EMAIL" | "DOMAIN" | "IP" | "UNKNOWN"

Type of pattern matching. Note: UNKNOWN is deprecated and cannot be used when creating or updating policies, but may be returned for existing entries.

One of the following:

"EMAIL"

"DOMAIN"

"IP"

"UNKNOWN"

verify_sender?: boolean

Enforce DMARC, SPF or DKIM authentication. When on, Email Security only honors policies that pass authentication.

AllowPolicyCreateResponse { id, created_at, last_modified, 12 more }

An email allow policy

id: string

Allow policy identifier

formatuuid

created_at: string

formatdate-time

Deprecatedlast_modified: string

Deprecated, use modified_at instead. End of life: November 1, 2026.

formatdate-time

comments?: string | null

maxLength1024

is_acceptable_sender?: boolean

Messages from this sender will be exempted from Spam, Spoof and Bulk dispositions. Note - This will not exempt messages with Malicious or Suspicious dispositions.

is_exempt_recipient?: boolean

Messages to this recipient will bypass all detections

Deprecatedis_recipient?: boolean

Deprecated as of July 1, 2025. Use is_exempt_recipient instead. End of life: July 1, 2026.

is_regex?: boolean

Deprecatedis_sender?: boolean

Deprecated as of July 1, 2025. Use is_trusted_sender instead. End of life: July 1, 2026.

Deprecatedis_spoof?: boolean

Deprecated as of July 1, 2025. Use is_acceptable_sender instead. End of life: July 1, 2026.

is_trusted_sender?: boolean

Messages from this sender will bypass all detections and link following

modified_at?: string

formatdate-time

pattern?: string

maxLength1024

minLength1

pattern_type?: "EMAIL" | "DOMAIN" | "IP" | "UNKNOWN"

Type of pattern matching. Note: UNKNOWN is deprecated and cannot be used when creating or updating policies, but may be returned for existing entries.

One of the following:

"EMAIL"

"DOMAIN"

"IP"

"UNKNOWN"

verify_sender?: boolean

Enforce DMARC, SPF or DKIM authentication. When on, Email Security only honors policies that pass authentication.

AllowPolicyEditResponse { id, created_at, last_modified, 12 more }

An email allow policy

id: string

Allow policy identifier

formatuuid

created_at: string

formatdate-time

Deprecatedlast_modified: string

Deprecated, use modified_at instead. End of life: November 1, 2026.

formatdate-time

comments?: string | null

maxLength1024

is_acceptable_sender?: boolean

Messages from this sender will be exempted from Spam, Spoof and Bulk dispositions. Note - This will not exempt messages with Malicious or Suspicious dispositions.

is_exempt_recipient?: boolean

Messages to this recipient will bypass all detections

Deprecatedis_recipient?: boolean

Deprecated as of July 1, 2025. Use is_exempt_recipient instead. End of life: July 1, 2026.

is_regex?: boolean

Deprecatedis_sender?: boolean

Deprecated as of July 1, 2025. Use is_trusted_sender instead. End of life: July 1, 2026.

Deprecatedis_spoof?: boolean

Deprecated as of July 1, 2025. Use is_acceptable_sender instead. End of life: July 1, 2026.

is_trusted_sender?: boolean

Messages from this sender will bypass all detections and link following

modified_at?: string

formatdate-time

pattern?: string

maxLength1024

minLength1

pattern_type?: "EMAIL" | "DOMAIN" | "IP" | "UNKNOWN"

Type of pattern matching. Note: UNKNOWN is deprecated and cannot be used when creating or updating policies, but may be returned for existing entries.

One of the following:

"EMAIL"

"DOMAIN"

"IP"

"UNKNOWN"

verify_sender?: boolean

Enforce DMARC, SPF or DKIM authentication. When on, Email Security only honors policies that pass authentication.

AllowPolicyDeleteResponse { id }

id: string

Allow policy identifier

formatuuid

SettingsBlock Senders

List blocked email senders

client.emailSecurity.settings.blockSenders.list(BlockSenderListParams { account_id, direction, order, 5 more } params, RequestOptionsoptions?): V4PagePaginationArray<BlockSenderListResponse { id, comments, created_at, 5 more } >

GET/accounts/{account_id}/email-security/settings/block_senders

Get a blocked email sender

client.emailSecurity.settings.blockSenders.get(stringpatternId, BlockSenderGetParams { account_id } params, RequestOptionsoptions?): BlockSenderGetResponse { id, comments, created_at, 5 more }

GET/accounts/{account_id}/email-security/settings/block_senders/{pattern_id}

Create blocked email sender

client.emailSecurity.settings.blockSenders.create(BlockSenderCreateParams { account_id, is_regex, pattern, 2 more } params, RequestOptionsoptions?): BlockSenderCreateResponse { id, comments, created_at, 5 more }

POST/accounts/{account_id}/email-security/settings/block_senders

Update a blocked email sender

client.emailSecurity.settings.blockSenders.edit(stringpatternId, BlockSenderEditParams { account_id, comments, is_regex, 2 more } params, RequestOptionsoptions?): BlockSenderEditResponse { id, comments, created_at, 5 more }

PATCH/accounts/{account_id}/email-security/settings/block_senders/{pattern_id}

Delete a blocked email sender

client.emailSecurity.settings.blockSenders.delete(stringpatternId, BlockSenderDeleteParams { account_id } params, RequestOptionsoptions?): BlockSenderDeleteResponse { id }

DELETE/accounts/{account_id}/email-security/settings/block_senders/{pattern_id}

ModelsExpand Collapse

BlockSenderListResponse { id, comments, created_at, 5 more }

A blocked sender pattern

id?: string

Blocked sender pattern identifier

formatuuid

comments?: string | null

maxLength1024

created_at?: string

formatdate-time

is_regex?: boolean

Deprecatedlast_modified?: string

Deprecated, use modified_at instead. End of life: November 1, 2026.

formatdate-time

modified_at?: string

formatdate-time

pattern?: string

maxLength1024

minLength1

pattern_type?: "EMAIL" | "DOMAIN" | "IP" | "UNKNOWN"

Type of pattern matching. Note: UNKNOWN is deprecated and cannot be used when creating or updating policies, but may be returned for existing entries.

One of the following:

"EMAIL"

"DOMAIN"

"IP"

"UNKNOWN"

BlockSenderGetResponse { id, comments, created_at, 5 more }

A blocked sender pattern

id?: string

Blocked sender pattern identifier

formatuuid

comments?: string | null

maxLength1024

created_at?: string

formatdate-time

is_regex?: boolean

Deprecatedlast_modified?: string

Deprecated, use modified_at instead. End of life: November 1, 2026.

formatdate-time

modified_at?: string

formatdate-time

pattern?: string

maxLength1024

minLength1

pattern_type?: "EMAIL" | "DOMAIN" | "IP" | "UNKNOWN"

Type of pattern matching. Note: UNKNOWN is deprecated and cannot be used when creating or updating policies, but may be returned for existing entries.

One of the following:

"EMAIL"

"DOMAIN"

"IP"

"UNKNOWN"

BlockSenderCreateResponse { id, comments, created_at, 5 more }

A blocked sender pattern

id?: string

Blocked sender pattern identifier

formatuuid

comments?: string | null

maxLength1024

created_at?: string

formatdate-time

is_regex?: boolean

Deprecatedlast_modified?: string

Deprecated, use modified_at instead. End of life: November 1, 2026.

formatdate-time

modified_at?: string

formatdate-time

pattern?: string

maxLength1024

minLength1

pattern_type?: "EMAIL" | "DOMAIN" | "IP" | "UNKNOWN"

Type of pattern matching. Note: UNKNOWN is deprecated and cannot be used when creating or updating policies, but may be returned for existing entries.

One of the following:

"EMAIL"

"DOMAIN"

"IP"

"UNKNOWN"

BlockSenderEditResponse { id, comments, created_at, 5 more }

A blocked sender pattern

id?: string

Blocked sender pattern identifier

formatuuid

comments?: string | null

maxLength1024

created_at?: string

formatdate-time

is_regex?: boolean

Deprecatedlast_modified?: string

Deprecated, use modified_at instead. End of life: November 1, 2026.

formatdate-time

modified_at?: string

formatdate-time

pattern?: string

maxLength1024

minLength1

pattern_type?: "EMAIL" | "DOMAIN" | "IP" | "UNKNOWN"

Type of pattern matching. Note: UNKNOWN is deprecated and cannot be used when creating or updating policies, but may be returned for existing entries.

One of the following:

"EMAIL"

"DOMAIN"

"IP"

"UNKNOWN"

BlockSenderDeleteResponse { id }

id: string

Blocked sender pattern identifier

formatuuid

SettingsDomains

List protected email domains

client.emailSecurity.settings.domains.list(DomainListParams { account_id, active_delivery_mode, allowed_delivery_mode, 8 more } params, RequestOptionsoptions?): V4PagePaginationArray<DomainListResponse { id, allowed_delivery_modes, authorization, 19 more } >

GET/accounts/{account_id}/email-security/settings/domains

Get an email domain

client.emailSecurity.settings.domains.get(stringdomainId, DomainGetParams { account_id } params, RequestOptionsoptions?): DomainGetResponse { id, allowed_delivery_modes, authorization, 19 more }

GET/accounts/{account_id}/email-security/settings/domains/{domain_id}

Update an email domain

client.emailSecurity.settings.domains.edit(stringdomainId, DomainEditParams { account_id, allowed_delivery_modes, domain, 9 more } params, RequestOptionsoptions?): DomainEditResponse { id, allowed_delivery_modes, authorization, 19 more }

PATCH/accounts/{account_id}/email-security/settings/domains/{domain_id}

Unprotect an email domain

client.emailSecurity.settings.domains.delete(stringdomainId, DomainDeleteParams { account_id } params, RequestOptionsoptions?): DomainDeleteResponse { id }

DELETE/accounts/{account_id}/email-security/settings/domains/{domain_id}

ModelsExpand Collapse

DomainListResponse { id, allowed_delivery_modes, authorization, 19 more }

id?: string

Domain identifier

formatuuid

allowed_delivery_modes?: Array<"DIRECT" | "BCC" | "JOURNAL" | 2 more>

One of the following:

"DIRECT"

"BCC"

"JOURNAL"

"API"

"RETRO_SCAN"

authorization?: Authorization { authorized, timestamp, status_message }

authorized: boolean

timestamp: string

formatdate-time

status_message?: string | null

created_at?: string

formatdate-time

dmarc_status?: "none" | "good" | "invalid"

One of the following:

"none"

"good"

"invalid"

domain?: string

drop_dispositions?: Array<"MALICIOUS" | "MALICIOUS-BEC" | "SUSPICIOUS" | 7 more>

One of the following:

"MALICIOUS"

"MALICIOUS-BEC"

"SUSPICIOUS"

"SPOOF"

"SPAM"

"BULK"

"ENCRYPTED"

"EXTERNAL"

"UNKNOWN"

"NONE"

emails_processed?: EmailsProcessed { timestamp, total_emails_processed, total_emails_processed_previous }

timestamp: string

formatdate-time

total_emails_processed: number

minimum0

total_emails_processed_previous: number

minimum0

folder?: "AllItems" | "Inbox"

One of the following:

"AllItems"

"Inbox"

inbox_provider?: "Microsoft" | "Google" | null

One of the following:

"Microsoft"

"Google"

integration_id?: string | null

formatuuid

ip_restrictions?: Array<string>

Deprecatedlast_modified?: string

Deprecated, use modified_at instead. End of life: November 1, 2026.

formatdate-time

lookback_hops?: number

modified_at?: string

formatdate-time

o365_tenant_id?: string | null

regions?: Array<"GLOBAL" | "AU" | "DE" | 2 more>

One of the following:

"GLOBAL"

"AU"

"DE"

"IN"

"US"

require_tls_inbound?: boolean | null

require_tls_outbound?: boolean | null

spf_status?: "none" | "good" | "neutral" | 2 more

One of the following:

"none"

"good"

"neutral"

"open"

"invalid"

status?: "pending" | "active" | "failed" | "timeout"

One of the following:

"pending"

"active"

"failed"

"timeout"

transport?: string

DomainGetResponse { id, allowed_delivery_modes, authorization, 19 more }

id?: string

Domain identifier

formatuuid

allowed_delivery_modes?: Array<"DIRECT" | "BCC" | "JOURNAL" | 2 more>

One of the following:

"DIRECT"

"BCC"

"JOURNAL"

"API"

"RETRO_SCAN"

authorization?: Authorization { authorized, timestamp, status_message }

authorized: boolean

timestamp: string

formatdate-time

status_message?: string | null

created_at?: string

formatdate-time

dmarc_status?: "none" | "good" | "invalid"

One of the following:

"none"

"good"

"invalid"

domain?: string

drop_dispositions?: Array<"MALICIOUS" | "MALICIOUS-BEC" | "SUSPICIOUS" | 7 more>

One of the following:

"MALICIOUS"

"MALICIOUS-BEC"

"SUSPICIOUS"

"SPOOF"

"SPAM"

"BULK"

"ENCRYPTED"

"EXTERNAL"

"UNKNOWN"

"NONE"

emails_processed?: EmailsProcessed { timestamp, total_emails_processed, total_emails_processed_previous }

timestamp: string

formatdate-time

total_emails_processed: number

minimum0

total_emails_processed_previous: number

minimum0

folder?: "AllItems" | "Inbox"

One of the following:

"AllItems"

"Inbox"

inbox_provider?: "Microsoft" | "Google" | null

One of the following:

"Microsoft"

"Google"

integration_id?: string | null

formatuuid

ip_restrictions?: Array<string>

Deprecatedlast_modified?: string

Deprecated, use modified_at instead. End of life: November 1, 2026.

formatdate-time

lookback_hops?: number

modified_at?: string

formatdate-time

o365_tenant_id?: string | null

regions?: Array<"GLOBAL" | "AU" | "DE" | 2 more>

One of the following:

"GLOBAL"

"AU"

"DE"

"IN"

"US"

require_tls_inbound?: boolean | null

require_tls_outbound?: boolean | null

spf_status?: "none" | "good" | "neutral" | 2 more

One of the following:

"none"

"good"

"neutral"

"open"

"invalid"

status?: "pending" | "active" | "failed" | "timeout"

One of the following:

"pending"

"active"

"failed"

"timeout"

transport?: string

DomainEditResponse { id, allowed_delivery_modes, authorization, 19 more }

id?: string

Domain identifier

formatuuid

allowed_delivery_modes?: Array<"DIRECT" | "BCC" | "JOURNAL" | 2 more>

One of the following:

"DIRECT"

"BCC"

"JOURNAL"

"API"

"RETRO_SCAN"

authorization?: Authorization { authorized, timestamp, status_message }

authorized: boolean

timestamp: string

formatdate-time

status_message?: string | null

created_at?: string

formatdate-time

dmarc_status?: "none" | "good" | "invalid"

One of the following:

"none"

"good"

"invalid"

domain?: string

drop_dispositions?: Array<"MALICIOUS" | "MALICIOUS-BEC" | "SUSPICIOUS" | 7 more>

One of the following:

"MALICIOUS"

"MALICIOUS-BEC"

"SUSPICIOUS"

"SPOOF"

"SPAM"

"BULK"

"ENCRYPTED"

"EXTERNAL"

"UNKNOWN"

"NONE"

emails_processed?: EmailsProcessed { timestamp, total_emails_processed, total_emails_processed_previous }

timestamp: string

formatdate-time

total_emails_processed: number

minimum0

total_emails_processed_previous: number

minimum0

folder?: "AllItems" | "Inbox"

One of the following:

"AllItems"

"Inbox"

inbox_provider?: "Microsoft" | "Google" | null

One of the following:

"Microsoft"

"Google"

integration_id?: string | null

formatuuid

ip_restrictions?: Array<string>

Deprecatedlast_modified?: string

Deprecated, use modified_at instead. End of life: November 1, 2026.

formatdate-time

lookback_hops?: number

modified_at?: string

formatdate-time

o365_tenant_id?: string | null

regions?: Array<"GLOBAL" | "AU" | "DE" | 2 more>

One of the following:

"GLOBAL"

"AU"

"DE"

"IN"

"US"

require_tls_inbound?: boolean | null

require_tls_outbound?: boolean | null

spf_status?: "none" | "good" | "neutral" | 2 more

One of the following:

"none"

"good"

"neutral"

"open"

"invalid"

status?: "pending" | "active" | "failed" | "timeout"

One of the following:

"pending"

"active"

"failed"

"timeout"

transport?: string

DomainDeleteResponse { id }

id: string

Domain identifier

formatuuid

SettingsImpersonation Registry

List entries in impersonation registry

client.emailSecurity.settings.impersonationRegistry.list(ImpersonationRegistryListParams { account_id, direction, order, 4 more } params, RequestOptionsoptions?): V4PagePaginationArray<ImpersonationRegistryListResponse { id, comments, created_at, 9 more } >

GET/accounts/{account_id}/email-security/settings/impersonation_registry

Get an impersonation registry entry

client.emailSecurity.settings.impersonationRegistry.get(stringimpersonationRegistryId, ImpersonationRegistryGetParams { account_id } params, RequestOptionsoptions?): ImpersonationRegistryGetResponse { id, comments, created_at, 9 more }

GET/accounts/{account_id}/email-security/settings/impersonation_registry/{impersonation_registry_id}

Create impersonation registry entry

client.emailSecurity.settings.impersonationRegistry.create(ImpersonationRegistryCreateParams { account_id, email, is_email_regex, 6 more } params, RequestOptionsoptions?): ImpersonationRegistryCreateResponse { id, comments, created_at, 9 more }

POST/accounts/{account_id}/email-security/settings/impersonation_registry

Update an impersonation registry entry

client.emailSecurity.settings.impersonationRegistry.edit(stringimpersonationRegistryId, ImpersonationRegistryEditParams { account_id, comments, directory_id, 6 more } params, RequestOptionsoptions?): ImpersonationRegistryEditResponse { id, comments, created_at, 9 more }

PATCH/accounts/{account_id}/email-security/settings/impersonation_registry/{impersonation_registry_id}

Delete an impersonation registry entry

client.emailSecurity.settings.impersonationRegistry.delete(stringimpersonationRegistryId, ImpersonationRegistryDeleteParams { account_id } params, RequestOptionsoptions?): ImpersonationRegistryDeleteResponse { id }

DELETE/accounts/{account_id}/email-security/settings/impersonation_registry/{impersonation_registry_id}

ModelsExpand Collapse

ImpersonationRegistryListResponse { id, comments, created_at, 9 more }

An impersonation registry entry

id?: string

Impersonation registry entry identifier

formatuuid

comments?: string | null

created_at?: string

formatdate-time

directory_id?: number | null

directory_node_id?: number | null

email?: string

Deprecatedexternal_directory_node_id?: string | null

is_email_regex?: boolean

Deprecatedlast_modified?: string

Deprecated, use modified_at instead. End of life: November 1, 2026.

formatdate-time

modified_at?: string

formatdate-time

name?: string

maxLength1024

provenance?: "A1S_INTERNAL" | "SNOOPY-CASB_OFFICE_365" | "SNOOPY-OFFICE_365" | "SNOOPY-GOOGLE_DIRECTORY"

One of the following:

"A1S_INTERNAL"

"SNOOPY-CASB_OFFICE_365"

"SNOOPY-OFFICE_365"

"SNOOPY-GOOGLE_DIRECTORY"

ImpersonationRegistryGetResponse { id, comments, created_at, 9 more }

An impersonation registry entry

id?: string

Impersonation registry entry identifier

formatuuid

comments?: string | null

created_at?: string

formatdate-time

directory_id?: number | null

directory_node_id?: number | null

email?: string

Deprecatedexternal_directory_node_id?: string | null

is_email_regex?: boolean

Deprecatedlast_modified?: string

Deprecated, use modified_at instead. End of life: November 1, 2026.

formatdate-time

modified_at?: string

formatdate-time

name?: string

maxLength1024

provenance?: "A1S_INTERNAL" | "SNOOPY-CASB_OFFICE_365" | "SNOOPY-OFFICE_365" | "SNOOPY-GOOGLE_DIRECTORY"

One of the following:

"A1S_INTERNAL"

"SNOOPY-CASB_OFFICE_365"

"SNOOPY-OFFICE_365"

"SNOOPY-GOOGLE_DIRECTORY"

ImpersonationRegistryCreateResponse { id, comments, created_at, 9 more }

An impersonation registry entry

id?: string

Impersonation registry entry identifier

formatuuid

comments?: string | null

created_at?: string

formatdate-time

directory_id?: number | null

directory_node_id?: number | null

email?: string

Deprecatedexternal_directory_node_id?: string | null

is_email_regex?: boolean

Deprecatedlast_modified?: string

Deprecated, use modified_at instead. End of life: November 1, 2026.

formatdate-time

modified_at?: string

formatdate-time

name?: string

maxLength1024

provenance?: "A1S_INTERNAL" | "SNOOPY-CASB_OFFICE_365" | "SNOOPY-OFFICE_365" | "SNOOPY-GOOGLE_DIRECTORY"

One of the following:

"A1S_INTERNAL"

"SNOOPY-CASB_OFFICE_365"

"SNOOPY-OFFICE_365"

"SNOOPY-GOOGLE_DIRECTORY"

ImpersonationRegistryEditResponse { id, comments, created_at, 9 more }

An impersonation registry entry

id?: string

Impersonation registry entry identifier

formatuuid

comments?: string | null

created_at?: string

formatdate-time

directory_id?: number | null

directory_node_id?: number | null

email?: string

Deprecatedexternal_directory_node_id?: string | null

is_email_regex?: boolean

Deprecatedlast_modified?: string

Deprecated, use modified_at instead. End of life: November 1, 2026.

formatdate-time

modified_at?: string

formatdate-time

name?: string

maxLength1024

provenance?: "A1S_INTERNAL" | "SNOOPY-CASB_OFFICE_365" | "SNOOPY-OFFICE_365" | "SNOOPY-GOOGLE_DIRECTORY"

One of the following:

"A1S_INTERNAL"

"SNOOPY-CASB_OFFICE_365"

"SNOOPY-OFFICE_365"

"SNOOPY-GOOGLE_DIRECTORY"

ImpersonationRegistryDeleteResponse { id }

id: string

Impersonation registry entry identifier

formatuuid

SettingsTrusted Domains

List trusted email domains

client.emailSecurity.settings.trustedDomains.list(TrustedDomainListParams { account_id, direction, is_recent, 6 more } params, RequestOptionsoptions?): V4PagePaginationArray<TrustedDomainListResponse { id, comments, created_at, 6 more } >

GET/accounts/{account_id}/email-security/settings/trusted_domains

Get a trusted email domain

client.emailSecurity.settings.trustedDomains.get(stringtrustedDomainId, TrustedDomainGetParams { account_id } params, RequestOptionsoptions?): TrustedDomainGetResponse { id, comments, created_at, 6 more }

GET/accounts/{account_id}/email-security/settings/trusted_domains/{trusted_domain_id}

Create trusted email domain

client.emailSecurity.settings.trustedDomains.create(TrustedDomainCreateParams { account_id, is_recent, is_regex, 3 more } params, RequestOptionsoptions?): TrustedDomainCreateResponse { id, comments, created_at, 6 more }

POST/accounts/{account_id}/email-security/settings/trusted_domains

Update a trusted email domain

client.emailSecurity.settings.trustedDomains.edit(stringtrustedDomainId, TrustedDomainEditParams { account_id, comments, is_recent, 3 more } params, RequestOptionsoptions?): TrustedDomainEditResponse { id, comments, created_at, 6 more }

PATCH/accounts/{account_id}/email-security/settings/trusted_domains/{trusted_domain_id}

Delete a trusted email domain

client.emailSecurity.settings.trustedDomains.delete(stringtrustedDomainId, TrustedDomainDeleteParams { account_id } params, RequestOptionsoptions?): TrustedDomainDeleteResponse { id }

DELETE/accounts/{account_id}/email-security/settings/trusted_domains/{trusted_domain_id}

ModelsExpand Collapse

TrustedDomainListResponse { id, comments, created_at, 6 more }

A trusted email domain

id?: string

Trusted domain identifier

formatuuid

comments?: string | null

maxLength1024

created_at?: string

formatdate-time

is_recent?: boolean

Select to prevent recently registered domains from triggering a Suspicious or Malicious disposition.

is_regex?: boolean

is_similarity?: boolean

Select for partner or other approved domains that have similar spelling to your connected domains. Prevents listed domains from triggering a Spoof disposition.

Deprecatedlast_modified?: string

Deprecated, use modified_at instead. End of life: November 1, 2026.

formatdate-time

modified_at?: string

formatdate-time

pattern?: string

maxLength1024

minLength1

TrustedDomainGetResponse { id, comments, created_at, 6 more }

A trusted email domain

id?: string

Trusted domain identifier

formatuuid

comments?: string | null

maxLength1024

created_at?: string

formatdate-time

is_recent?: boolean

Select to prevent recently registered domains from triggering a Suspicious or Malicious disposition.

is_regex?: boolean

is_similarity?: boolean

Select for partner or other approved domains that have similar spelling to your connected domains. Prevents listed domains from triggering a Spoof disposition.

Deprecatedlast_modified?: string

Deprecated, use modified_at instead. End of life: November 1, 2026.

formatdate-time

modified_at?: string

formatdate-time

pattern?: string

maxLength1024

minLength1

TrustedDomainCreateResponse { id, comments, created_at, 6 more }

A trusted email domain

id?: string

Trusted domain identifier

formatuuid

comments?: string | null

maxLength1024

created_at?: string

formatdate-time

is_recent?: boolean

Select to prevent recently registered domains from triggering a Suspicious or Malicious disposition.

is_regex?: boolean

is_similarity?: boolean

Select for partner or other approved domains that have similar spelling to your connected domains. Prevents listed domains from triggering a Spoof disposition.

Deprecatedlast_modified?: string

Deprecated, use modified_at instead. End of life: November 1, 2026.

formatdate-time

modified_at?: string

formatdate-time

pattern?: string

maxLength1024

minLength1

TrustedDomainEditResponse { id, comments, created_at, 6 more }

A trusted email domain

id?: string

Trusted domain identifier

formatuuid

comments?: string | null

maxLength1024

created_at?: string

formatdate-time

is_recent?: boolean

Select to prevent recently registered domains from triggering a Suspicious or Malicious disposition.

is_regex?: boolean

is_similarity?: boolean

Select for partner or other approved domains that have similar spelling to your connected domains. Prevents listed domains from triggering a Spoof disposition.

Deprecatedlast_modified?: string

Deprecated, use modified_at instead. End of life: November 1, 2026.

formatdate-time

modified_at?: string

formatdate-time

pattern?: string

maxLength1024

minLength1

TrustedDomainDeleteResponse { id }

id: string

Trusted domain identifier

formatuuid