Language

English Français 日本語 한국어 Español

Datadog Site

Site help
US1 US3 US5 EU AP1 AP2 US1-FED US2-FED

Update an entity context sync configuration

Note: This endpoint is in preview and is subject to change. If you have any feedback, contact Datadog support.

PATCH https://api.ap1.datadoghq.com/api/v2/security_monitoring/configuration/integration_config/{integration_config_id}https://api.ap2.datadoghq.com/api/v2/security_monitoring/configuration/integration_config/{integration_config_id}https://api.datadoghq.eu/api/v2/security_monitoring/configuration/integration_config/{integration_config_id}https://api.ddog-gov.com/api/v2/security_monitoring/configuration/integration_config/{integration_config_id}https://api.us2.ddog-gov.com/api/v2/security_monitoring/configuration/integration_config/{integration_config_id}https://api.datadoghq.com/api/v2/security_monitoring/configuration/integration_config/{integration_config_id}https://api.us3.datadoghq.com/api/v2/security_monitoring/configuration/integration_config/{integration_config_id}https://api.us5.datadoghq.com/api/v2/security_monitoring/configuration/integration_config/{integration_config_id}

Overview

Update an existing entity context sync configuration. Supports partial updates; only the fields provided in the request body are modified. This endpoint requires the manage_integrations permission.

OAuth apps require the manage_integrations authorization scope to access this endpoint.

Arguments

Path Parameters

Name

Type

Description

integration_config_id [required]

string

The ID of the entity context sync configuration.

Request

Body Data (required)

The fields to update on the integration configuration.

Expand All

Field

Type

Description

data [required]

object

The entity context sync configuration fields to update.

attributes [required]

object

Fields to update on the entity context sync configuration. All fields are optional.

domain

string

The new domain associated with the external entity source.

enabled

boolean

Whether the entity context sync should be enabled.

integration_type

enum

The type of external source that provides entities to Cloud SIEM. Allowed enum values: GOOGLE_WORKSPACE,OKTA,ENTRA_ID

name

string

The new display name for the entity context sync configuration.

secrets

object

The secrets used to authenticate against the external entity source. The accepted keys depend on the source type (for example, admin_email for Google Workspace).

settings

object

Free-form, non-sensitive settings for the entity context sync. The accepted keys depend on the source type.

type [required]

enum

The type of the resource. The value should always be integration_config. Allowed enum values: integration_config

default: integration_config

{
  "data": {
    "attributes": {
      "domain": "siem-test.com",
      "enabled": true,
      "integration_type": "GOOGLE_WORKSPACE",
      "name": "My GWS Integration (renamed)",
      "secrets": {
        "admin_email": "test@example.com"
      },
      "settings": {
        "setting1": "value1"
      }
    },
    "type": "integration_config"
  }
}

Response

OK

Response containing a single entity context sync configuration.

Expand All

Field

Type

Description

data [required]

object

An entity context sync configuration.

attributes [required]

object

The attributes of an entity context sync configuration as returned by the API.

created_at

date-time

The time at which the entity context sync configuration was created.

domain [required]

string

The domain associated with the external entity source (for example, the customer's identity provider domain).

enabled [required]

boolean

Whether the sync is enabled and actively ingesting entities into Cloud SIEM.

integration_type [required]

enum

The type of external source that provides entities to Cloud SIEM. Allowed enum values: GOOGLE_WORKSPACE,OKTA,ENTRA_ID

modified_at

date-time

The time at which the entity context sync configuration was last modified.

name

string

The display name of the entity context sync configuration.

settings

object

Free-form, non-sensitive settings for the entity context sync. The accepted keys depend on the source type.

state

enum

The state of the credentials configured on the entity context sync. Allowed enum values: valid,invalid,initializing

id [required]

string

The unique identifier of the integration configuration.

type [required]

enum

The type of the resource. The value should always be integration_config. Allowed enum values: integration_config

default: integration_config

{
  "data": {
    "attributes": {
      "created_at": "2026-05-01T12:00:00Z",
      "domain": "siem-test.com",
      "enabled": true,
      "integration_type": "GOOGLE_WORKSPACE",
      "modified_at": "2026-05-01T12:00:00Z",
      "name": "My GWS Integration",
      "settings": {
        "setting1": "value1"
      },
      "state": "valid"
    },
    "id": "11111111-2222-3333-4444-555555555555",
    "type": "integration_config"
  }
}

Bad Request

API error response.

Expand All

Field

Type

Description

errors [required]

[string]

A list of errors.

{
  "errors": [
    "Bad Request"
  ]
}

Not Authorized

API error response.

Expand All

Field

Type

Description

errors [required]

[string]

A list of errors.

{
  "errors": [
    "Bad Request"
  ]
}

Not Found

API error response.

Expand All

Field

Type

Description

errors [required]

[string]

A list of errors.

{
  "errors": [
    "Bad Request"
  ]
}

Too many requests

API error response.

Expand All

Field

Type

Description

errors [required]

[string]

A list of errors.

{
  "errors": [
    "Bad Request"
  ]
}

Code Example

                  ## default
# 

# Path parameters
export integration_config_id="CHANGE_ME"
# Curl command
curl -X PATCH "https://api.ap1.datadoghq.com"https://api.ap2.datadoghq.com"https://api.datadoghq.eu"https://api.ddog-gov.com"https://api.us2.ddog-gov.com"https://api.datadoghq.com"https://api.us3.datadoghq.com"https://api.us5.datadoghq.com/api/v2/security_monitoring/configuration/integration_config/${integration_config_id}" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "DD-API-KEY: ${DD_API_KEY}" \
-H "DD-APPLICATION-KEY: ${DD_APP_KEY}" \
-d @- << EOF
{
  "data": {
    "attributes": {
      "enabled": false,
      "name": "My GWS Integration (renamed)"
    },
    "type": "integration_config"
  }
}
EOF