Skip to content
Cloudflare API
Start here
API Reference
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}

Updates a display name entry used for impersonation protection.

Security

API Email + API Key

The previous authorization scheme for interacting with the Cloudflare API, used in conjunction with a Global API key.

Example:X-Auth-Email: user@example.com

The previous authorization scheme for interacting with the Cloudflare API. When possible, use API tokens instead of Global API keys.

Example:X-Auth-Key: 144c9defac04969c7bfad8efaa8ea194
Accepted Permissions (at least one required)
Cloud Email Security: Write
ParametersExpand Collapse
account_id: str

Account Identifier

maxLength32
minLength32
display_name_id: int
formatint32
email: Optional[str]
is_email_regex: Optional[bool]
name: Optional[str]
maxLength1024
ReturnsExpand Collapse
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]

Update an entry in impersonation registry

import os
from cloudflare import Cloudflare

client = Cloudflare(
    api_email=os.environ.get("CLOUDFLARE_EMAIL"),  # This is the default and can be omitted
    api_key=os.environ.get("CLOUDFLARE_API_KEY"),  # This is the default and can be omitted
)
response = client.email_security.settings.impersonation_registry.edit(
    display_name_id=2403,
    account_id="023e105f4ecef8ad9ca31a8372d0c353",
)
print(response.id)
{
  "errors": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "messages": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "result": {
    "id": 2403,
    "created_at": "2019-12-27T18:11:19.117Z",
    "email": "email",
    "is_email_regex": true,
    "last_modified": "2019-12-27T18:11:19.117Z",
    "name": "name",
    "comments": "comments",
    "directory_id": 0,
    "directory_node_id": 0,
    "external_directory_node_id": "external_directory_node_id",
    "provenance": "provenance"
  },
  "success": true
}
Returns Examples
{
  "errors": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "messages": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "result": {
    "id": 2403,
    "created_at": "2019-12-27T18:11:19.117Z",
    "email": "email",
    "is_email_regex": true,
    "last_modified": "2019-12-27T18:11:19.117Z",
    "name": "name",
    "comments": "comments",
    "directory_id": 0,
    "directory_node_id": 0,
    "external_directory_node_id": "external_directory_node_id",
    "provenance": "provenance"
  },
  "success": true
}