API Reference

Email Security

Settings

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Impersonation Registry

List impersonation registry entries

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

Optional note describing the entry.

created_at: optional string

formatdate-time

directory_id: optional number

Identifier of the directory the entry was synced from, when directory-synced.

directory_node_id: optional number

Identifier of the directory node the entry was synced from, when directory-synced.

email: optional string

Email address (or pattern) of the protected identity.

Deprecatedexternal_directory_node_id: optional string

This field is deprecated.

Deprecated. External identifier of the directory node.

is_email_regex: optional boolean

Whether email is a regular expression instead of a literal address.

Deprecatedlast_modified: optional string

Use modified_at instead.

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

formatdate-time

modified_at: optional string

formatdate-time

name: optional string

Display name of the protected identity.

maxLength1024

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

Source the entry was created from.

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

Optional note describing the entry.

created_at: optional string

formatdate-time

directory_id: optional number

Identifier of the directory the entry was synced from, when directory-synced.

directory_node_id: optional number

Identifier of the directory node the entry was synced from, when directory-synced.

email: optional string

Email address (or pattern) of the protected identity.

Deprecatedexternal_directory_node_id: optional string

This field is deprecated.

Deprecated. External identifier of the directory node.

is_email_regex: optional boolean

Whether email is a regular expression instead of a literal address.

Deprecatedlast_modified: optional string

Use modified_at instead.

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

formatdate-time

modified_at: optional string

formatdate-time

name: optional string

Display name of the protected identity.

maxLength1024

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

Source the entry was created from.

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

Optional note describing the entry.

created_at: optional string

formatdate-time

directory_id: optional number

Identifier of the directory the entry was synced from, when directory-synced.

directory_node_id: optional number

Identifier of the directory node the entry was synced from, when directory-synced.

email: optional string

Email address (or pattern) of the protected identity.

Deprecatedexternal_directory_node_id: optional string

This field is deprecated.

Deprecated. External identifier of the directory node.

is_email_regex: optional boolean

Whether email is a regular expression instead of a literal address.

Deprecatedlast_modified: optional string

Use modified_at instead.

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

formatdate-time

modified_at: optional string

formatdate-time

name: optional string

Display name of the protected identity.

maxLength1024

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

Source the entry was created from.

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

Optional note describing the entry.

created_at: optional string

formatdate-time

directory_id: optional number

Identifier of the directory the entry was synced from, when directory-synced.

directory_node_id: optional number

Identifier of the directory node the entry was synced from, when directory-synced.

email: optional string

Email address (or pattern) of the protected identity.

Deprecatedexternal_directory_node_id: optional string

This field is deprecated.

Deprecated. External identifier of the directory node.

is_email_regex: optional boolean

Whether email is a regular expression instead of a literal address.

Deprecatedlast_modified: optional string

Use modified_at instead.

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

formatdate-time

modified_at: optional string

formatdate-time

name: optional string

Display name of the protected identity.

maxLength1024

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

Source the entry was created from.

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