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/{integration_type}/activate https://api.ap2.datadoghq.com/api/v2/security_monitoring/configuration/integration_config/{integration_type}/activate https://api.datadoghq.eu/api/v2/security_monitoring/configuration/integration_config/{integration_type}/activate https://api.ddog-gov.com/api/v2/security_monitoring/configuration/integration_config/{integration_type}/activate https://api.us2.ddog-gov.com/api/v2/security_monitoring/configuration/integration_config/{integration_type}/activate https://api.uk1.datadoghq.com/api/v2/security_monitoring/configuration/integration_config/{integration_type}/activate https://api.datadoghq.com/api/v2/security_monitoring/configuration/integration_config/{integration_type}/activate https://api.us3.datadoghq.com/api/v2/security_monitoring/configuration/integration_config/{integration_type}/activate https://api.us5.datadoghq.com/api/v2/security_monitoring/configuration/integration_config/{integration_type}/activate
Overview Activate an entity context sync integration for a source type that does not require manually
supplied credentials (for example, Entra ID). If an integration of this type already exists,
it is returned (re-enabling it first if it was disabled) instead of creating a duplicate.
This endpoint requires the manage_integrations permission.
OAuth apps require the manage_integrations authorization scope to access this endpoint.
Arguments Path Parameters integration_type [required ]
The integration type to activate (for example, entra_id).
Request Body Data Optional configuration overrides for the integration to activate.
Expand All
The configuration overrides for the integration to activate.
Overrides applied when activating the integration. All fields are optional.
The domain associated with the external entity source.
The display name for the entity context sync configuration.
Free-form, non-sensitive settings for the entity context sync. The accepted keys depend on the source type.
The type of the resource. The value should always be activate_entra_id_request.
Allowed enum values: activate_entra_id_request
default: activate_entra_id_request
{
"data" : {
"attributes" : {
"domain" : "default" ,
"name" : "My Entra ID Integration" ,
"settings" : {
"setting1" : "value1"
}
},
"type" : "activate_entra_id_request"
}
} Response OK
Response containing a single entity context sync configuration.
Expand All
An entity context sync configuration.
The attributes of an entity context sync configuration as returned by the API.
The time at which the entity context sync configuration was created.
The domain associated with the external entity source (for example, the customer's identity provider domain).
Whether the sync is enabled and actively ingesting entities into Cloud SIEM.
integration_type [required ]
The type of external source that provides entities to Cloud SIEM.
Allowed enum values: GOOGLE_WORKSPACE,OKTA,ENTRA_ID,CROWDSTRIKE,SENTINELONE
The time at which the entity context sync configuration was last modified.
The display name of the entity context sync configuration.
Free-form, non-sensitive settings for the entity context sync. The accepted keys depend on the source type.
The state of the credentials configured on the entity context sync.
Allowed enum values: valid,invalid,initializing
The unique identifier of the integration configuration.
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
{
"errors" : [
"Bad Request"
]
} Not Authorized
{
"errors" : [
"Bad Request"
]
} Not Found
{
"errors" : [
"Bad Request"
]
} Too many requests
{
"errors" : [
"Bad Request"
]
} Code Example Copy
## default
#
# Path parameters export integration_type = "entra_id" # 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.uk1.datadoghq.com "https://api.datadoghq.com "https://api.us3.datadoghq.com "https://api.us5.datadoghq.com /api/v2/security_monitoring/configuration/integration_config/${integration_type}/activate " \
-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": {
"name": "My Entra ID Integration"
},
"type": "activate_entra_id_request"
}
}
EOF
"""
Activate an entity context sync integration returns "OK" response
"""
from datadog_api_client import ApiClient , Configuration
from datadog_api_client.v2.api.security_monitoring_api import SecurityMonitoringApi
from datadog_api_client.v2.model.security_monitoring_integration_activate_attributes import (
SecurityMonitoringIntegrationActivateAttributes ,
)
from datadog_api_client.v2.model.security_monitoring_integration_activate_data import (
SecurityMonitoringIntegrationActivateData ,
)
from datadog_api_client.v2.model.security_monitoring_integration_activate_request import (
SecurityMonitoringIntegrationActivateRequest ,
)
from datadog_api_client.v2.model.security_monitoring_integration_activate_resource_type import (
SecurityMonitoringIntegrationActivateResourceType ,
)
from datadog_api_client.v2.model.security_monitoring_integration_config_settings import (
SecurityMonitoringIntegrationConfigSettings ,
)
body = SecurityMonitoringIntegrationActivateRequest (
data = SecurityMonitoringIntegrationActivateData (
attributes = SecurityMonitoringIntegrationActivateAttributes (
domain = "default" ,
name = "My Entra ID Integration" ,
settings = SecurityMonitoringIntegrationConfigSettings ([( "setting1" , "value1" )]),
),
type = SecurityMonitoringIntegrationActivateResourceType . ACTIVATE_ENTRA_ID_REQUEST ,
),
)
configuration = Configuration ()
configuration . unstable_operations [ "activate_integration" ] = True
with ApiClient ( configuration ) as api_client :
api_instance = SecurityMonitoringApi ( api_client )
response = api_instance . activate_integration ( integration_type = "entra_id" , body = body )
print ( response )
Instructions First install the library and its dependencies and then save the example to example.py and run following commands:
DD_SITE = "datadoghq.com us3.datadoghq.com us5.datadoghq.com datadoghq.eu ap1.datadoghq.com ap2.datadoghq.com uk1.datadoghq.com ddog-gov.com us2.ddog-gov.com " DD_API_KEY = "<DD_API_KEY>" DD_APP_KEY = "<DD_APP_KEY>" python3 "example.py"
# Activate an entity context sync integration returns "OK" response
require "datadog_api_client"
DatadogAPIClient . configure do | config |
config . unstable_operations [ "v2.activate_integration" . to_sym ] = true
end
api_instance = DatadogAPIClient :: V2 :: SecurityMonitoringAPI . new
body = DatadogAPIClient :: V2 :: SecurityMonitoringIntegrationActivateRequest . new ({
data : DatadogAPIClient :: V2 :: SecurityMonitoringIntegrationActivateData . new ({
attributes : DatadogAPIClient :: V2 :: SecurityMonitoringIntegrationActivateAttributes . new ({
domain : "default" ,
name : "My Entra ID Integration" ,
settings : DatadogAPIClient :: V2 :: SecurityMonitoringIntegrationConfigSettings . new ({}),
}),
type : DatadogAPIClient :: V2 :: SecurityMonitoringIntegrationActivateResourceType :: ACTIVATE_ENTRA_ID_REQUEST ,
}),
})
opts = {
body : body ,
}
p api_instance . activate_integration ( "entra_id" , opts )
Instructions First install the library and its dependencies and then save the example to example.rb and run following commands:
DD_SITE = "datadoghq.com us3.datadoghq.com us5.datadoghq.com datadoghq.eu ap1.datadoghq.com ap2.datadoghq.com uk1.datadoghq.com ddog-gov.com us2.ddog-gov.com " DD_API_KEY = "<DD_API_KEY>" DD_APP_KEY = "<DD_APP_KEY>" rb "example.rb"
// Activate an entity context sync integration returns "OK" response
package main
import (
"context"
"encoding/json"
"fmt"
"os"
"github.com/DataDog/datadog-api-client-go/v2/api/datadog"
"github.com/DataDog/datadog-api-client-go/v2/api/datadogV2"
)
func main () {
body := datadogV2 . SecurityMonitoringIntegrationActivateRequest {
Data : & datadogV2 . SecurityMonitoringIntegrationActivateData {
Attributes : & datadogV2 . SecurityMonitoringIntegrationActivateAttributes {
Domain : datadog . PtrString ( "default" ),
Name : datadog . PtrString ( "My Entra ID Integration" ),
Settings : map [ string ] interface {}{
"setting1" : "value1" ,
},
},
Type : datadogV2 . SECURITYMONITORINGINTEGRATIONACTIVATERESOURCETYPE_ACTIVATE_ENTRA_ID_REQUEST . Ptr (),
},
}
ctx := datadog . NewDefaultContext ( context . Background ())
configuration := datadog . NewConfiguration ()
configuration . SetUnstableOperationEnabled ( "v2.ActivateIntegration" , true )
apiClient := datadog . NewAPIClient ( configuration )
api := datadogV2 . NewSecurityMonitoringApi ( apiClient )
resp , r , err := api . ActivateIntegration ( ctx , "entra_id" , * datadogV2 . NewActivateIntegrationOptionalParameters (). WithBody ( body ))
if err != nil {
fmt . Fprintf ( os . Stderr , "Error when calling `SecurityMonitoringApi.ActivateIntegration`: %v\n" , err )
fmt . Fprintf ( os . Stderr , "Full HTTP response: %v\n" , r )
}
responseContent , _ := json . MarshalIndent ( resp , "" , " " )
fmt . Fprintf ( os . Stdout , "Response from `SecurityMonitoringApi.ActivateIntegration`:\n%s\n" , responseContent )
}
Instructions First install the library and its dependencies and then save the example to main.go and run following commands:
DD_SITE = "datadoghq.com us3.datadoghq.com us5.datadoghq.com datadoghq.eu ap1.datadoghq.com ap2.datadoghq.com uk1.datadoghq.com ddog-gov.com us2.ddog-gov.com " DD_API_KEY = "<DD_API_KEY>" DD_APP_KEY = "<DD_APP_KEY>" go run "main.go"
// Activate an entity context sync integration returns "OK" response
import com.datadog.api.client.ApiClient ;
import com.datadog.api.client.ApiException ;
import com.datadog.api.client.v2.api.SecurityMonitoringApi ;
import com.datadog.api.client.v2.api.SecurityMonitoringApi.ActivateIntegrationOptionalParameters ;
import com.datadog.api.client.v2.model.SecurityMonitoringIntegrationActivateAttributes ;
import com.datadog.api.client.v2.model.SecurityMonitoringIntegrationActivateData ;
import com.datadog.api.client.v2.model.SecurityMonitoringIntegrationActivateRequest ;
import com.datadog.api.client.v2.model.SecurityMonitoringIntegrationActivateResourceType ;
import com.datadog.api.client.v2.model.SecurityMonitoringIntegrationConfigResponse ;
import java.util.Map ;
public class Example {
public static void main ( String [] args ) {
ApiClient defaultClient = ApiClient . getDefaultApiClient ();
defaultClient . setUnstableOperationEnabled ( "v2.activateIntegration" , true );
SecurityMonitoringApi apiInstance = new SecurityMonitoringApi ( defaultClient );
SecurityMonitoringIntegrationActivateRequest body =
new SecurityMonitoringIntegrationActivateRequest ()
. data (
new SecurityMonitoringIntegrationActivateData ()
. attributes (
new SecurityMonitoringIntegrationActivateAttributes ()
. domain ( "default" )
. name ( "My Entra ID Integration" )
. settings ( Map . ofEntries ( Map . entry ( "setting1" , "value1" ))))
. type (
SecurityMonitoringIntegrationActivateResourceType
. ACTIVATE_ENTRA_ID_REQUEST ));
try {
SecurityMonitoringIntegrationConfigResponse result =
apiInstance . activateIntegration (
"entra_id" , new ActivateIntegrationOptionalParameters (). body ( body ));
System . out . println ( result );
} catch ( ApiException e ) {
System . err . println ( "Exception when calling SecurityMonitoringApi#activateIntegration" );
System . err . println ( "Status code: " + e . getCode ());
System . err . println ( "Reason: " + e . getResponseBody ());
System . err . println ( "Response headers: " + e . getResponseHeaders ());
e . printStackTrace ();
}
}
}
Instructions First install the library and its dependencies and then save the example to Example.java and run following commands:
DD_SITE = "datadoghq.com us3.datadoghq.com us5.datadoghq.com datadoghq.eu ap1.datadoghq.com ap2.datadoghq.com uk1.datadoghq.com ddog-gov.com us2.ddog-gov.com " DD_API_KEY = "<DD_API_KEY>" DD_APP_KEY = "<DD_APP_KEY>" java "Example.java"
// Activate an entity context sync integration returns "OK" response
use datadog_api_client ::datadog ;
use datadog_api_client ::datadogV2 ::api_security_monitoring ::ActivateIntegrationOptionalParams ;
use datadog_api_client ::datadogV2 ::api_security_monitoring ::SecurityMonitoringAPI ;
use datadog_api_client ::datadogV2 ::model ::SecurityMonitoringIntegrationActivateAttributes ;
use datadog_api_client ::datadogV2 ::model ::SecurityMonitoringIntegrationActivateData ;
use datadog_api_client ::datadogV2 ::model ::SecurityMonitoringIntegrationActivateRequest ;
use datadog_api_client ::datadogV2 ::model ::SecurityMonitoringIntegrationActivateResourceType ;
use serde_json ::Value ;
use std ::collections ::BTreeMap ;
#[tokio::main]
async fn main () {
let body = SecurityMonitoringIntegrationActivateRequest ::new (). data (
SecurityMonitoringIntegrationActivateData ::new ()
. attributes (
SecurityMonitoringIntegrationActivateAttributes ::new ()
. domain ( "default" . to_string ())
. name ( "My Entra ID Integration" . to_string ())
. settings ( BTreeMap ::from ([(
"setting1" . to_string (),
Value ::from ( "value1" ),
)])),
)
. type_ ( SecurityMonitoringIntegrationActivateResourceType ::ACTIVATE_ENTRA_ID_REQUEST ),
);
let mut configuration = datadog ::Configuration ::new ();
configuration . set_unstable_operation_enabled ( "v2.ActivateIntegration" , true );
let api = SecurityMonitoringAPI ::with_config ( configuration );
let resp = api
. activate_integration (
"entra_id" . to_string (),
ActivateIntegrationOptionalParams ::default (). body ( body ),
)
. await ;
if let Ok ( value ) = resp {
println! ( " {:#?} " , value );
} else {
println! ( " {:#?} " , resp . unwrap_err ());
}
}
Instructions First install the library and its dependencies and then save the example to src/main.rs and run following commands:
DD_SITE = "datadoghq.com us3.datadoghq.com us5.datadoghq.com datadoghq.eu ap1.datadoghq.com ap2.datadoghq.com uk1.datadoghq.com ddog-gov.com us2.ddog-gov.com " DD_API_KEY = "<DD_API_KEY>" DD_APP_KEY = "<DD_APP_KEY>" cargo run
/**
* Activate an entity context sync integration returns "OK" response
*/
import { client , v2 } from "@datadog/datadog-api-client" ;
const configuration = client . createConfiguration ();
configuration . unstableOperations [ "v2.activateIntegration" ] = true ;
const apiInstance = new v2 . SecurityMonitoringApi ( configuration );
const params : v2.SecurityMonitoringApiActivateIntegrationRequest = {
body : {
data : {
attributes : {
domain : "default" ,
name : "My Entra ID Integration" ,
settings : {
setting1 : "value1" ,
},
},
type : "activate_entra_id_request" ,
},
},
integrationType : "entra_id" ,
};
apiInstance
. activateIntegration ( params )
. then (( data : v2.SecurityMonitoringIntegrationConfigResponse ) => {
console . log (
"API called successfully. Returned data: " + JSON . stringify ( data )
);
})
. catch (( error : any ) => console . error ( error ));
Instructions First install the library and its dependencies and then save the example to example.ts and run following commands:
DD_SITE = "datadoghq.com us3.datadoghq.com us5.datadoghq.com datadoghq.eu ap1.datadoghq.com ap2.datadoghq.com uk1.datadoghq.com ddog-gov.com us2.ddog-gov.com " DD_API_KEY = "<DD_API_KEY>" DD_APP_KEY = "<DD_APP_KEY>" tsc "example.ts"