Skip to content
Cloudflare API
Start here
API Reference
Email Security
Settings

Impersonation Registry

List entries in impersonation registry
email_security.settings.impersonation_registry.list(ImpersonationRegistryListParams**kwargs) -> SyncV4PagePaginationArray[ImpersonationRegistryListResponse]
GET/accounts/{account_id}/email-security/settings/impersonation_registry
Get an entry in impersonation registry
email_security.settings.impersonation_registry.get(intdisplay_name_id, ImpersonationRegistryGetParams**kwargs) -> ImpersonationRegistryGetResponse
GET/accounts/{account_id}/email-security/settings/impersonation_registry/{display_name_id}
Create an entry in impersonation registry
email_security.settings.impersonation_registry.create(ImpersonationRegistryCreateParams**kwargs) -> ImpersonationRegistryCreateResponse
POST/accounts/{account_id}/email-security/settings/impersonation_registry
Update an entry in impersonation registry
email_security.settings.impersonation_registry.edit(intdisplay_name_id, ImpersonationRegistryEditParams**kwargs) -> ImpersonationRegistryEditResponse
PATCH/accounts/{account_id}/email-security/settings/impersonation_registry/{display_name_id}
Delete an entry from impersonation registry
email_security.settings.impersonation_registry.delete(intdisplay_name_id, ImpersonationRegistryDeleteParams**kwargs) -> ImpersonationRegistryDeleteResponse
DELETE/accounts/{account_id}/email-security/settings/impersonation_registry/{display_name_id}
ModelsExpand Collapse
class ImpersonationRegistryListResponse: …
id: int
formatint32
created_at: datetime
formatdate-time
email: str
is_email_regex: bool
last_modified: datetime
formatdate-time
name: str
maxLength1024
comments: Optional[str]
directory_id: Optional[int]
formatint64
directory_node_id: Optional[int]
formatint64
Deprecatedexternal_directory_node_id: Optional[str]
provenance: Optional[str]
class ImpersonationRegistryGetResponse: …
id: int
formatint32
created_at: datetime
formatdate-time
email: str
is_email_regex: bool
last_modified: datetime
formatdate-time
name: str
maxLength1024
comments: Optional[str]
directory_id: Optional[int]
formatint64
directory_node_id: Optional[int]
formatint64
Deprecatedexternal_directory_node_id: Optional[str]
provenance: Optional[str]
class ImpersonationRegistryCreateResponse: …
id: int
formatint32
created_at: datetime
formatdate-time
email: str
is_email_regex: bool
last_modified: datetime
formatdate-time
name: str
maxLength1024
comments: Optional[str]
directory_id: Optional[int]
formatint64
directory_node_id: Optional[int]
formatint64
Deprecatedexternal_directory_node_id: Optional[str]
provenance: Optional[str]
class ImpersonationRegistryEditResponse: …
id: int
formatint32
created_at: datetime
formatdate-time
email: str
is_email_regex: bool
last_modified: datetime
formatdate-time
name: str
maxLength1024
comments: Optional[str]
directory_id: Optional[int]
formatint64
directory_node_id: Optional[int]
formatint64
Deprecatedexternal_directory_node_id: Optional[str]
provenance: Optional[str]
class ImpersonationRegistryDeleteResponse: …
id: int
formatint32