Validate entity context sync credentials

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

POST https://api.ap1.datadoghq.com/api/v2/security_monitoring/configuration/integration_config/validatehttps://api.ap2.datadoghq.com/api/v2/security_monitoring/configuration/integration_config/validatehttps://api.datadoghq.eu/api/v2/security_monitoring/configuration/integration_config/validatehttps://api.ddog-gov.com/api/v2/security_monitoring/configuration/integration_config/validatehttps://api.us2.ddog-gov.com/api/v2/security_monitoring/configuration/integration_config/validatehttps://api.datadoghq.com/api/v2/security_monitoring/configuration/integration_config/validatehttps://api.us3.datadoghq.com/api/v2/security_monitoring/configuration/integration_config/validatehttps://api.us5.datadoghq.com/api/v2/security_monitoring/configuration/integration_config/validate

Overview

Validate a set of credentials against the external entity source before creating a sync configuration. Returns a 200 status code if the credentials are valid. This endpoint requires the integrations_read permission.

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

Request

Body Data (required)

The credentials to validate.

Expand All

Field

Type

Description

data [required]

object

The credentials to validate.

attributes [required]

object

The credentials to validate against the external entity source.

domain [required]

string

The domain associated with the external entity source.

integration_type [required]

enum

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

secrets [required]

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).

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",
      "integration_type": "GOOGLE_WORKSPACE",
      "secrets": {
        "admin_email": "test@example.com"
      }
    },
    "type": "integration_config"
  }
}

Response

OK

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"
  ]
}

Too many requests

API error response.

Expand All

Field

Type

Description

errors [required]

[string]

A list of errors.

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

Code Example

                  ## default
# 

# Curl command
curl -X POST "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/validate" \ -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": { "domain": "siem-test.com", "integration_type": "GOOGLE_WORKSPACE", "secrets": { "admin_email": "test@example.com" } }, "type": "integration_config" } } EOF