Update an impersonation registry entry

client.EmailSecurity.Settings.ImpersonationRegistry.Edit(ctx, impersonationRegistryID, params) (*SettingImpersonationRegistryEditResponse, error)

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

Updates an existing impersonation registry entry. Only provided fields will be modified. Directory-synced entries can’t be updated.

Security

API Token

The preferred authorization scheme for interacting with the Cloudflare API. Create a token.

Example:Authorization: Bearer Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY

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

impersonationRegistryID string

Impersonation registry entry identifier

formatuuid

params SettingImpersonationRegistryEditParams

AccountID param.Field[string]

Path param: Identifier.

maxLength32

Comments param.Field[string]Optional

Body param

DirectoryID param.Field[int64]Optional

Body param

DirectoryNodeID param.Field[int64]Optional

Body param

Email param.Field[string]Optional

Body param

DeprecatedExternalDirectoryNodeID param.Field[string]Optional

Body param

IsEmailRegex param.Field[bool]Optional

Body param

Name param.Field[string]Optional

Body param

maxLength1024

Provenance param.Field[SettingImpersonationRegistryEditParamsProvenance]Optional

Body param

const SettingImpersonationRegistryEditParamsProvenanceA1SInternal SettingImpersonationRegistryEditParamsProvenance = "A1S_INTERNAL"

const SettingImpersonationRegistryEditParamsProvenanceSnoopyCasbOffice365 SettingImpersonationRegistryEditParamsProvenance = "SNOOPY-CASB_OFFICE_365"

const SettingImpersonationRegistryEditParamsProvenanceSnoopyOffice365 SettingImpersonationRegistryEditParamsProvenance = "SNOOPY-OFFICE_365"

const SettingImpersonationRegistryEditParamsProvenanceSnoopyGoogleDirectory SettingImpersonationRegistryEditParamsProvenance = "SNOOPY-GOOGLE_DIRECTORY"

ReturnsExpand Collapse

type SettingImpersonationRegistryEditResponse struct{…}

An impersonation registry entry

ID stringOptional

Impersonation registry entry identifier

formatuuid

Comments stringOptional

CreatedAt TimeOptional

formatdate-time

DirectoryID int64Optional

DirectoryNodeID int64Optional

Email stringOptional

DeprecatedExternalDirectoryNodeID stringOptional

IsEmailRegex boolOptional

DeprecatedLastModified TimeOptional

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

formatdate-time

ModifiedAt TimeOptional

formatdate-time

Name stringOptional

maxLength1024

Provenance SettingImpersonationRegistryEditResponseProvenanceOptional

One of the following:

const SettingImpersonationRegistryEditResponseProvenanceA1SInternal SettingImpersonationRegistryEditResponseProvenance = "A1S_INTERNAL"

const SettingImpersonationRegistryEditResponseProvenanceSnoopyCasbOffice365 SettingImpersonationRegistryEditResponseProvenance = "SNOOPY-CASB_OFFICE_365"

const SettingImpersonationRegistryEditResponseProvenanceSnoopyOffice365 SettingImpersonationRegistryEditResponseProvenance = "SNOOPY-OFFICE_365"

const SettingImpersonationRegistryEditResponseProvenanceSnoopyGoogleDirectory SettingImpersonationRegistryEditResponseProvenance = "SNOOPY-GOOGLE_DIRECTORY"

Update an impersonation registry entry

package main

import (
  "context"
  "fmt"

  "github.com/stainless-sdks/cloudflare-go"
  "github.com/stainless-sdks/cloudflare-go/email_security"
  "github.com/stainless-sdks/cloudflare-go/option"
)

func main() {
  client := cloudflare.NewClient(
    option.WithAPIToken("Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY"),
  )
  response, err := client.EmailSecurity.Settings.ImpersonationRegistry.Edit(
    context.TODO(),
    "f174e90a-fafe-4643-bbbc-4a0ed4fc8415",
    email_security.SettingImpersonationRegistryEditParams{
      AccountID: cloudflare.F("023e105f4ecef8ad9ca31a8372d0c353"),
    },
  )
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", 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"
      }
    }
  ],
  "success": true,
  "result": {
    "id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415",
    "comments": "comments",
    "created_at": "2014-01-01T05:20:00.12345Z",
    "directory_id": 0,
    "directory_node_id": 0,
    "email": "john.doe@example.com",
    "external_directory_node_id": "external_directory_node_id",
    "is_email_regex": false,
    "last_modified": "2014-01-01T05:20:00.12345Z",
    "modified_at": "2014-01-01T05:20:00.12345Z",
    "name": "John Doe",
    "provenance": "A1S_INTERNAL"
  }
}

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"
      }
    }
  ],
  "success": true,
  "result": {
    "id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415",
    "comments": "comments",
    "created_at": "2014-01-01T05:20:00.12345Z",
    "directory_id": 0,
    "directory_node_id": 0,
    "email": "john.doe@example.com",
    "external_directory_node_id": "external_directory_node_id",
    "is_email_regex": false,
    "last_modified": "2014-01-01T05:20:00.12345Z",
    "modified_at": "2014-01-01T05:20:00.12345Z",
    "name": "John Doe",
    "provenance": "A1S_INTERNAL"
  }
}