--- title: Associer Teams à GitHub Teams description: Cet endpoint tente d'associer vos équipes Datadog existantes à des équipes GitHub en comparant leurs noms. breadcrumbs: Documentation > API > Associer Teams à GitHub Teams --- > For the complete documentation index, see [llms.txt](https://dnd37xeb23o8n.cloudfront.net/stefon.simmons/docs-astro-web-10435/llms.txt). # Associer Teams à GitHub Teams ## v2 (latest) | Datadog site | API endpoint | | ----------------- | --------------------------------------------------- | | app.datadoghq.com | POST https://api.datadoghq.com/api/v2/team/sync | | us3.datadoghq.com | POST https://api.us3.datadoghq.com/api/v2/team/sync | | us5.datadoghq.com | POST https://api.us5.datadoghq.com/api/v2/team/sync | | app.datadoghq.eu | POST https://api.datadoghq.eu/api/v2/team/sync | | ap1.datadoghq.com | POST https://api.ap1.datadoghq.com/api/v2/team/sync | | ap2.datadoghq.com | POST https://api.ap2.datadoghq.com/api/v2/team/sync | | uk1.datadoghq.com | POST https://api.uk1.datadoghq.com/api/v2/team/sync | | app.ddog-gov.com | POST https://api.ddog-gov.com/api/v2/team/sync | | us2.ddog-gov.com | POST https://api.us2.ddog-gov.com/api/v2/team/sync | ### Overview Cet endpoint tente d'associer vos équipes Datadog existantes à des équipes GitHub en comparant leurs noms. Il évalue toutes les équipes Datadog actuelles et les compare aux équipes de l'organisation GitHub connectée à votre compte Datadog, en se basant sur le handle d'équipe Datadog et le slug d'équipe GitHub (en minuscules et au format kebab-case). Cette opération est en lecture seule côté GitHub ; aucune équipe ne sera modifiée ou créée. [Une organisation GitHub doit être connectée à votre compte Datadog](https://docs.datadoghq.com/integrations/github.md), et l'application GitHub intégrée à Datadog doit disposer de l'autorisation `Members Read`. La correspondance est effectuée en comparant le handle d'équipe Datadog au slug d'équipe GitHub à l'aide d'une correspondance exacte normalisée ; la casse est ignorée et les espaces sont supprimés. Aucune modification n'est apportée aux équipes dans GitHub. Cette opération crée uniquement de nouvelles équipes dans Datadog lorsque le type est défini sur `provision`. This endpoint requires the `teams_manage` permission. OAuth apps require the `teams_manage` authorization [scope](https://dnd37xeb23o8n.cloudfront.net/stefon.simmons/docs-astro-web-10435/fr/api/latest/scopes.md#teams) to access this endpoint. ### Request #### Body Data (required) {% tabs %} {% tab label="Model" %} | Parent field | Field | Type | Description | | --------------- | ------------------------ | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | | data [*required*] | object | Requête de synchronisation d'équipe. | | data | attributes [*required*] | object | Team sync attributes. | | attributes | frequency | enum | How often the sync process should be run. Defaults to `once` when not provided. Allowed enum values: `once`, `continuously`, `paused`. | | attributes | selection_state | [object] | Specifies which teams or organizations to sync. When provided, synchronization is limited to the specified items and their subtrees. | | selection_state | external_id [*required*] | object | The external identifier for a team or organization in the source platform. | | external_id | type [*required*] | enum | The type of external identifier for the selection state item. For GitHub synchronization, `team` refers to a GitHub team and `organization` refers to a GitHub organization. For ServiceNow synchronization, `team` refers to a ServiceNow group and `organization` refers to a ServiceNow instance. Allowed enum values: `team`, `organization`. | | external_id | value [*required*] | string | The external identifier value from the source platform. For GitHub, this is the string representation of a GitHub organization ID or team ID. For ServiceNow, this is the instance name for `organization`, or `/` of the group for `team`. | | selection_state | operation | enum | The operation to perform on the selected hierarchy. When set to `include`, synchronization covers the referenced teams or organizations. Allowed enum values: `include`. | | selection_state | scope | enum | The scope of the selection. When set to `subtree`, synchronization includes the referenced team or organization and everything nested under it. Allowed enum values: `subtree`. | | attributes | source [*required*] | enum | The external source platform for team synchronization. Allowed enum values: `github`, `servicenow`. | | attributes | sync_membership | boolean | Whether to sync members from the external team to the Datadog team. Defaults to `false` when not provided. Default: `false`. | | attributes | type [*required*] | enum | The type of synchronization operation. "link" connects teams by matching names. "provision" creates new teams when no match is found. Allowed enum values: `link`, `provision`. | | data | id | string | The sync's identifier | | data | type [*required*] | enum | Team sync bulk type. Allowed enum values: `team_sync_bulk`. | {% /tab %} {% tab label="Example" %} ```json { "data": { "attributes": { "source": "github", "type": "link", "selection_state": [ { "external_id": { "type": "organization", "value": "1" } } ] }, "type": "team_sync_bulk" } } ``` {% /tab %} {% /tabs %} ### Response {% tabs %} {% tab label="200" %} OK {% /tab %} {% tab label="204" %} No Content {% /tab %} {% tab label="403" %} Forbidden {% tabs %} {% tab label="Model" %} API error response. | Field | Type | Description | | ------------------- | -------- | ----------------- | | errors [*required*] | [string] | A list of errors. | {% /tab %} {% tab label="Example" %} ```json { "errors": [ "Bad Request" ] } ``` {% /tab %} {% /tabs %} {% /tab %} {% tab label="429" %} Too many requests {% tabs %} {% tab label="Model" %} API error response. | Field | Type | Description | | ------------------- | -------- | ----------------- | | errors [*required*] | [string] | A list of errors. | {% /tab %} {% tab label="Example" %} ```json { "errors": [ "Bad Request" ] } ``` {% /tab %} {% /tabs %} {% /tab %} {% tab label="500" %} Internal Server Error - Unexpected error during linking. {% tabs %} {% tab label="Model" %} API error response. | Field | Type | Description | | ------------------- | -------- | ----------------- | | errors [*required*] | [string] | A list of errors. | {% /tab %} {% tab label="Example" %} ```json { "errors": [ "Bad Request" ] } ``` {% /tab %} {% /tabs %} {% /tab %} {% /tabs %} ### Code Example {% tabs %} {% tab label="Curl" %} ```bash # Set your Datadog site and credentials export DD_SITE="datadoghq.com" # Or us3.datadoghq.com, us5.datadoghq.com, datadoghq.eu, ap1.datadoghq.com, ap2.datadoghq.com, uk1.datadoghq.com, ddog-gov.com, us2.ddog-gov.com # Use a Personal Access Token or Service Access Token export DD_BEARER_TOKEN="" curl -X POST "https://api.${DD_SITE}/api/v2/team/sync" \ -H "Content-Type: application/json" \ -H "Authorization: Bearer ${DD_BEARER_TOKEN}" \ -d @- << EOF { "data": { "attributes": { "source": "github", "type": "link", "selection_state": [ { "external_id": { "type": "organization", "value": "1" } } ] }, "type": "team_sync_bulk" } } EOF ``` {% /tab %} {% tab label="Go" %} ```go // Link Teams with GitHub Teams returns "OK" response package main import ( "context" "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.TeamSyncRequest{ Data: datadogV2.TeamSyncData{ Attributes: datadogV2.TeamSyncAttributes{ Source: datadogV2.TEAMSYNCATTRIBUTESSOURCE_GITHUB, Type: datadogV2.TEAMSYNCATTRIBUTESTYPE_LINK, }, Type: datadogV2.TEAMSYNCBULKTYPE_TEAM_SYNC_BULK, }, } ctx := datadog.NewDefaultContext(context.Background()) ctx = context.WithValue(ctx, datadog.ContextAccessToken, os.Getenv("DD_BEARER_TOKEN")) configuration := datadog.NewConfiguration() apiClient := datadog.NewAPIClient(configuration) api := datadogV2.NewTeamsApi(apiClient) r, err := api.SyncTeams(ctx, body) if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `TeamsApi.SyncTeams`: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) } } ``` #### Instructions First [install the library and its dependencies](https://dnd37xeb23o8n.cloudfront.net/api/latest.md?code-lang=go) and then save the example to `main.go` and run following commands: ```bash DD_SITE="datadoghq.com" DD_BEARER_TOKEN="" go run "main.go" ``` {% /tab %} {% tab label="Java" %} ```java // Link Teams with GitHub Teams returns "OK" response import com.datadog.api.client.ApiClient; import com.datadog.api.client.ApiException; import com.datadog.api.client.v2.api.TeamsApi; import com.datadog.api.client.v2.model.TeamSyncAttributes; import com.datadog.api.client.v2.model.TeamSyncAttributesSource; import com.datadog.api.client.v2.model.TeamSyncAttributesType; import com.datadog.api.client.v2.model.TeamSyncBulkType; import com.datadog.api.client.v2.model.TeamSyncData; import com.datadog.api.client.v2.model.TeamSyncRequest; public class Example { public static void main(String[] args) { ApiClient defaultClient = ApiClient.getDefaultApiClient(); defaultClient.setAccessToken(System.getenv("DD_BEARER_TOKEN")); TeamsApi apiInstance = new TeamsApi(defaultClient); TeamSyncRequest body = new TeamSyncRequest() .data( new TeamSyncData() .attributes( new TeamSyncAttributes() .source(TeamSyncAttributesSource.GITHUB) .type(TeamSyncAttributesType.LINK)) .type(TeamSyncBulkType.TEAM_SYNC_BULK)); try { apiInstance.syncTeams(body); } catch (ApiException e) { System.err.println("Exception when calling TeamsApi#syncTeams"); 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](https://dnd37xeb23o8n.cloudfront.net/api/latest.md?code-lang=java) and then save the example to `Example.java` and run following commands: ```bash DD_SITE="datadoghq.com" DD_BEARER_TOKEN="" java "Example.java" ``` {% /tab %} {% tab label="Python" %} ```python """ Link Teams with GitHub Teams returns "OK" response """ from os import environ from datadog_api_client import ApiClient, Configuration from datadog_api_client.v2.api.teams_api import TeamsApi from datadog_api_client.v2.model.team_sync_attributes import TeamSyncAttributes from datadog_api_client.v2.model.team_sync_attributes_source import TeamSyncAttributesSource from datadog_api_client.v2.model.team_sync_attributes_type import TeamSyncAttributesType from datadog_api_client.v2.model.team_sync_bulk_type import TeamSyncBulkType from datadog_api_client.v2.model.team_sync_data import TeamSyncData from datadog_api_client.v2.model.team_sync_request import TeamSyncRequest body = TeamSyncRequest( data=TeamSyncData( attributes=TeamSyncAttributes( source=TeamSyncAttributesSource.GITHUB, type=TeamSyncAttributesType.LINK, ), type=TeamSyncBulkType.TEAM_SYNC_BULK, ), ) configuration = Configuration() configuration.access_token = environ["DD_BEARER_TOKEN"] with ApiClient(configuration) as api_client: api_instance = TeamsApi(api_client) api_instance.sync_teams(body=body) ``` #### Instructions First [install the library and its dependencies](https://dnd37xeb23o8n.cloudfront.net/api/latest.md?code-lang=python) and then save the example to `example.py` and run following commands: ```bash DD_SITE="datadoghq.com" DD_BEARER_TOKEN="" python3 "example.py" ``` {% /tab %} {% tab label="Ruby" %} ```ruby # Link Teams with GitHub Teams returns "OK" response require "datadog_api_client" DatadogAPIClient.configure do |config| config.access_token = ENV["DD_BEARER_TOKEN"] end api_instance = DatadogAPIClient::V2::TeamsAPI.new body = DatadogAPIClient::V2::TeamSyncRequest.new({ data: DatadogAPIClient::V2::TeamSyncData.new({ attributes: DatadogAPIClient::V2::TeamSyncAttributes.new({ source: DatadogAPIClient::V2::TeamSyncAttributesSource::GITHUB, type: DatadogAPIClient::V2::TeamSyncAttributesType::LINK, }), type: DatadogAPIClient::V2::TeamSyncBulkType::TEAM_SYNC_BULK, }), }) p api_instance.sync_teams(body) ``` #### Instructions First [install the library and its dependencies](https://dnd37xeb23o8n.cloudfront.net/api/latest.md?code-lang=ruby) and then save the example to `example.rb` and run following commands: ```bash DD_SITE="datadoghq.com" DD_BEARER_TOKEN="" rb "example.rb" ``` {% /tab %} {% tab label="Rust" %} ```rust // Link Teams with GitHub Teams returns "OK" response use datadog_api_client::datadog; use datadog_api_client::datadogV2::api_teams::TeamsAPI; use datadog_api_client::datadogV2::model::TeamSyncAttributes; use datadog_api_client::datadogV2::model::TeamSyncAttributesSource; use datadog_api_client::datadogV2::model::TeamSyncAttributesType; use datadog_api_client::datadogV2::model::TeamSyncBulkType; use datadog_api_client::datadogV2::model::TeamSyncData; use datadog_api_client::datadogV2::model::TeamSyncRequest; #[tokio::main] async fn main() { let body = TeamSyncRequest::new(TeamSyncData::new( TeamSyncAttributes::new( TeamSyncAttributesSource::GITHUB, TeamSyncAttributesType::LINK, ), TeamSyncBulkType::TEAM_SYNC_BULK, )); let configuration = datadog::Configuration::new(); let api = TeamsAPI::with_config(configuration); let resp = api.sync_teams(body).await; if let Ok(value) = resp { println!("{:#?}", value); } else { println!("{:#?}", resp.unwrap_err()); } } ``` #### Instructions First [install the library and its dependencies](https://dnd37xeb23o8n.cloudfront.net/api/latest.md?code-lang=rust) and then save the example to `src/main.rs` and run following commands: ```bash DD_SITE="datadoghq.com" DD_API_KEY="" DD_APP_KEY="" cargo run ``` {% /tab %} {% tab label="TypeScript" %} ```typescript /** * Link Teams with GitHub Teams returns "OK" response */ import { client, v2 } from "@datadog/datadog-api-client"; const configuration = client.createConfiguration({ authMethods: { AuthZ: { accessToken: process.env.DD_BEARER_TOKEN as string, }, }, }); const apiInstance = new v2.TeamsApi(configuration); const params: v2.TeamsApiSyncTeamsRequest = { body: { data: { attributes: { source: "github", type: "link", }, type: "team_sync_bulk", }, }, }; apiInstance .syncTeams(params) .then((data: any) => { console.log( "API called successfully. Returned data: " + JSON.stringify(data) ); }) .catch((error: any) => console.error(error)); ``` #### Instructions First [install the library and its dependencies](https://dnd37xeb23o8n.cloudfront.net/api/latest.md?code-lang=typescript) and then save the example to `example.ts` and run following commands: ```bash DD_SITE="datadoghq.com" DD_BEARER_TOKEN="" tsc "example.ts" ``` {% /tab %} {% /tabs %}