API Reference

Email Security

Settings

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Impersonation Registry

List entries in impersonation registry

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

Get an impersonation registry entry

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

Create impersonation registry entry

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

Update an impersonation registry entry

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

Delete an impersonation registry entry

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

ModelsExpand Collapse

ImpersonationRegistryListResponse object { id, comments, created_at, 9 more }

An impersonation registry entry

id: optional string

Impersonation registry entry identifier

formatuuid

comments: optional string

created_at: optional string

formatdate-time

directory_id: optional number

directory_node_id: optional number

email: optional string

Deprecatedexternal_directory_node_id: optional string

is_email_regex: optional boolean

Deprecatedlast_modified: optional string

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

formatdate-time

modified_at: optional string

formatdate-time

name: optional string

maxLength1024

provenance: optional "A1S_INTERNAL" or "SNOOPY-CASB_OFFICE_365" or "SNOOPY-OFFICE_365" or "SNOOPY-GOOGLE_DIRECTORY"

One of the following:

"A1S_INTERNAL"

"SNOOPY-CASB_OFFICE_365"

"SNOOPY-OFFICE_365"

"SNOOPY-GOOGLE_DIRECTORY"

ImpersonationRegistryGetResponse object { id, comments, created_at, 9 more }

An impersonation registry entry

id: optional string

Impersonation registry entry identifier

formatuuid

comments: optional string

created_at: optional string

formatdate-time

directory_id: optional number

directory_node_id: optional number

email: optional string

Deprecatedexternal_directory_node_id: optional string

is_email_regex: optional boolean

Deprecatedlast_modified: optional string

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

formatdate-time

modified_at: optional string

formatdate-time

name: optional string

maxLength1024

provenance: optional "A1S_INTERNAL" or "SNOOPY-CASB_OFFICE_365" or "SNOOPY-OFFICE_365" or "SNOOPY-GOOGLE_DIRECTORY"

One of the following:

"A1S_INTERNAL"

"SNOOPY-CASB_OFFICE_365"

"SNOOPY-OFFICE_365"

"SNOOPY-GOOGLE_DIRECTORY"

ImpersonationRegistryCreateResponse object { id, comments, created_at, 9 more }

An impersonation registry entry

id: optional string

Impersonation registry entry identifier

formatuuid

comments: optional string

created_at: optional string

formatdate-time

directory_id: optional number

directory_node_id: optional number

email: optional string

Deprecatedexternal_directory_node_id: optional string

is_email_regex: optional boolean

Deprecatedlast_modified: optional string

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

formatdate-time

modified_at: optional string

formatdate-time

name: optional string

maxLength1024

provenance: optional "A1S_INTERNAL" or "SNOOPY-CASB_OFFICE_365" or "SNOOPY-OFFICE_365" or "SNOOPY-GOOGLE_DIRECTORY"

One of the following:

"A1S_INTERNAL"

"SNOOPY-CASB_OFFICE_365"

"SNOOPY-OFFICE_365"

"SNOOPY-GOOGLE_DIRECTORY"

ImpersonationRegistryEditResponse object { id, comments, created_at, 9 more }

An impersonation registry entry

id: optional string

Impersonation registry entry identifier

formatuuid

comments: optional string

created_at: optional string

formatdate-time

directory_id: optional number

directory_node_id: optional number

email: optional string

Deprecatedexternal_directory_node_id: optional string

is_email_regex: optional boolean

Deprecatedlast_modified: optional string

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

formatdate-time

modified_at: optional string

formatdate-time

name: optional string

maxLength1024

provenance: optional "A1S_INTERNAL" or "SNOOPY-CASB_OFFICE_365" or "SNOOPY-OFFICE_365" or "SNOOPY-GOOGLE_DIRECTORY"

One of the following:

"A1S_INTERNAL"

"SNOOPY-CASB_OFFICE_365"

"SNOOPY-OFFICE_365"

"SNOOPY-GOOGLE_DIRECTORY"

ImpersonationRegistryDeleteResponse object { id }

id: string

Impersonation registry entry identifier

formatuuid