Bulk update org group memberships

v2 (latest)

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/org_group_memberships/bulkhttps://api.ap2.datadoghq.com/api/v2/org_group_memberships/bulkhttps://api.datadoghq.eu/api/v2/org_group_memberships/bulkhttps://api.ddog-gov.com/api/v2/org_group_memberships/bulkhttps://api.us2.ddog-gov.com/api/v2/org_group_memberships/bulkhttps://api.uk1.datadoghq.com/api/v2/org_group_memberships/bulkhttps://api.datadoghq.com/api/v2/org_group_memberships/bulkhttps://api.us3.datadoghq.com/api/v2/org_group_memberships/bulkhttps://api.us5.datadoghq.com/api/v2/org_group_memberships/bulk

Overview

Move a batch of organizations from one organization group to another. This is an atomic operation. Each request must include between 1 and 100 organizations. Each organization must be identified by a unique org_uuid and org_site pair, and must be in the same site as the requesting organization. This endpoint requires the org_group_write permission.

Request

Body Data (required)

Expand All

Field

Type

Description

data [required]

object

Data for bulk updating org group memberships.

{
  "data": {
    "attributes": {
      "orgs": [
        {
          "org_site": "us1",
          "org_uuid": "c3d4e5f6-a7b8-9012-cdef-012345678901"
        }
      ]
    },
    "relationships": {
      "source_org_group": {
        "data": {
          "id": "a1b2c3d4-e5f6-7890-abcd-ef0123456789",
          "type": "org_groups"
        }
      },
      "target_org_group": {
        "data": {
          "id": "a1b2c3d4-e5f6-7890-abcd-ef0123456789",
          "type": "org_groups"
        }
      }
    },
    "type": "org_group_membership_bulk_updates"
  }
}

Response

Response containing a list of org group memberships.

Expand All

Field

Type

Description

data [required]

[object]

An array of org group memberships.

links

object

Pagination links for navigating between pages of an org group list response.

Code Example

                  ## default
# 

# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"

# 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.uk1.datadoghq.com"https://api.datadoghq.com"https://api.us3.datadoghq.com"https://api.us5.datadoghq.com/api/v2/org_group_memberships/bulk" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
  "data": {
    "attributes": {
      "orgs": [
        {
          "org_site": "us1",
          "org_uuid": "c3d4e5f6-a7b8-9012-cdef-012345678901"
        }
      ]
    },
    "relationships": {
      "source_org_group": {
        "data": {
          "id": "a1b2c3d4-e5f6-7890-abcd-ef0123456789",
          "type": "org_groups"
        }
      },
      "target_org_group": {
        "data": {
          "id": "d4e5f6a7-b890-1234-cdef-567890abcdef",
          "type": "org_groups"
        }
      }
    },
    "type": "org_group_membership_bulk_updates"
  }
}
EOF

                

"""
Bulk update org group memberships returns "OK" response
"""

from os import environ
from datadog_api_client import ApiClient, Configuration
from datadog_api_client.v2.api.org_groups_api import OrgGroupsApi
from datadog_api_client.v2.model.global_org_identifier import GlobalOrgIdentifier
from datadog_api_client.v2.model.org_group_membership_bulk_update_attributes import (
    OrgGroupMembershipBulkUpdateAttributes,
)
from datadog_api_client.v2.model.org_group_membership_bulk_update_data import OrgGroupMembershipBulkUpdateData
from datadog_api_client.v2.model.org_group_membership_bulk_update_relationships import (
    OrgGroupMembershipBulkUpdateRelationships,
)
from datadog_api_client.v2.model.org_group_membership_bulk_update_request import OrgGroupMembershipBulkUpdateRequest
from datadog_api_client.v2.model.org_group_membership_bulk_update_type import OrgGroupMembershipBulkUpdateType
from datadog_api_client.v2.model.org_group_relationship_to_one import OrgGroupRelationshipToOne
from datadog_api_client.v2.model.org_group_relationship_to_one_data import OrgGroupRelationshipToOneData
from datadog_api_client.v2.model.org_group_type import OrgGroupType
from uuid import UUID

body = OrgGroupMembershipBulkUpdateRequest(
    data=OrgGroupMembershipBulkUpdateData(
        attributes=OrgGroupMembershipBulkUpdateAttributes(
            orgs=[
                GlobalOrgIdentifier(
                    org_site="us1",
                    org_uuid=UUID("c3d4e5f6-a7b8-9012-cdef-012345678901"),
                ),
            ],
        ),
        relationships=OrgGroupMembershipBulkUpdateRelationships(
            source_org_group=OrgGroupRelationshipToOne(
                data=OrgGroupRelationshipToOneData(
                    id=UUID("a1b2c3d4-e5f6-7890-abcd-ef0123456789"),
                    type=OrgGroupType.ORG_GROUPS,
                ),
            ),
            target_org_group=OrgGroupRelationshipToOne(
                data=OrgGroupRelationshipToOneData(
                    id=UUID("a1b2c3d4-e5f6-7890-abcd-ef0123456789"),
                    type=OrgGroupType.ORG_GROUPS,
                ),
            ),
        ),
        type=OrgGroupMembershipBulkUpdateType.ORG_GROUP_MEMBERSHIP_BULK_UPDATES,
    ),
)

configuration = Configuration()
configuration.access_token = environ["DD_BEARER_TOKEN"]
configuration.unstable_operations["bulk_update_org_group_memberships"] = True
with ApiClient(configuration) as api_client:
    api_instance = OrgGroupsApi(api_client)
    response = api_instance.bulk_update_org_group_memberships(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.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comuk1.datadoghq.comddog-gov.comus2.ddog-gov.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" python3 "example.py"

# Bulk update org group memberships returns "OK" response

require "datadog_api_client"
DatadogAPIClient.configure do |config|
  config.access_token = ENV["DD_BEARER_TOKEN"]
  config.unstable_operations["v2.bulk_update_org_group_memberships".to_sym] = true
end
api_instance = DatadogAPIClient::V2::OrgGroupsAPI.new

body = DatadogAPIClient::V2::OrgGroupMembershipBulkUpdateRequest.new({
  data: DatadogAPIClient::V2::OrgGroupMembershipBulkUpdateData.new({
    attributes: DatadogAPIClient::V2::OrgGroupMembershipBulkUpdateAttributes.new({
      orgs: [
        DatadogAPIClient::V2::GlobalOrgIdentifier.new({
          org_site: "us1",
          org_uuid: "c3d4e5f6-a7b8-9012-cdef-012345678901",
        }),
      ],
    }),
    relationships: DatadogAPIClient::V2::OrgGroupMembershipBulkUpdateRelationships.new({
      source_org_group: DatadogAPIClient::V2::OrgGroupRelationshipToOne.new({
        data: DatadogAPIClient::V2::OrgGroupRelationshipToOneData.new({
          id: "a1b2c3d4-e5f6-7890-abcd-ef0123456789",
          type: DatadogAPIClient::V2::OrgGroupType::ORG_GROUPS,
        }),
      }),
      target_org_group: DatadogAPIClient::V2::OrgGroupRelationshipToOne.new({
        data: DatadogAPIClient::V2::OrgGroupRelationshipToOneData.new({
          id: "a1b2c3d4-e5f6-7890-abcd-ef0123456789",
          type: DatadogAPIClient::V2::OrgGroupType::ORG_GROUPS,
        }),
      }),
    }),
    type: DatadogAPIClient::V2::OrgGroupMembershipBulkUpdateType::ORG_GROUP_MEMBERSHIP_BULK_UPDATES,
  }),
})
p api_instance.bulk_update_org_group_memberships(body)

Instructions

First install the library and its dependencies and then save the example to example.rb and run following commands:

    DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comuk1.datadoghq.comddog-gov.comus2.ddog-gov.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" rb "example.rb"

// Bulk update org group memberships 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"
	"github.com/google/uuid"
)

func main() {
	body := datadogV2.OrgGroupMembershipBulkUpdateRequest{
		Data: datadogV2.OrgGroupMembershipBulkUpdateData{
			Attributes: datadogV2.OrgGroupMembershipBulkUpdateAttributes{
				Orgs: []datadogV2.GlobalOrgIdentifier{
					{
						OrgSite: "us1",
						OrgUuid: uuid.MustParse("c3d4e5f6-a7b8-9012-cdef-012345678901"),
					},
				},
			},
			Relationships: datadogV2.OrgGroupMembershipBulkUpdateRelationships{
				SourceOrgGroup: datadogV2.OrgGroupRelationshipToOne{
					Data: datadogV2.OrgGroupRelationshipToOneData{
						Id:   uuid.MustParse("a1b2c3d4-e5f6-7890-abcd-ef0123456789"),
						Type: datadogV2.ORGGROUPTYPE_ORG_GROUPS,
					},
				},
				TargetOrgGroup: datadogV2.OrgGroupRelationshipToOne{
					Data: datadogV2.OrgGroupRelationshipToOneData{
						Id:   uuid.MustParse("a1b2c3d4-e5f6-7890-abcd-ef0123456789"),
						Type: datadogV2.ORGGROUPTYPE_ORG_GROUPS,
					},
				},
			},
			Type: datadogV2.ORGGROUPMEMBERSHIPBULKUPDATETYPE_ORG_GROUP_MEMBERSHIP_BULK_UPDATES,
		},
	}
	ctx := datadog.NewDefaultContext(context.Background())
	ctx = context.WithValue(ctx, datadog.ContextAccessToken, os.Getenv("DD_BEARER_TOKEN"))
	configuration := datadog.NewConfiguration()
	configuration.SetUnstableOperationEnabled("v2.BulkUpdateOrgGroupMemberships", true)
	apiClient := datadog.NewAPIClient(configuration)
	api := datadogV2.NewOrgGroupsApi(apiClient)
	resp, r, err := api.BulkUpdateOrgGroupMemberships(ctx, body)

	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `OrgGroupsApi.BulkUpdateOrgGroupMemberships`: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}

	responseContent, _ := json.MarshalIndent(resp, "", "  ")
	fmt.Fprintf(os.Stdout, "Response from `OrgGroupsApi.BulkUpdateOrgGroupMemberships`:\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.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comuk1.datadoghq.comddog-gov.comus2.ddog-gov.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" go run "main.go"

// Bulk update org group memberships returns "OK" response

import com.datadog.api.client.ApiClient;
import com.datadog.api.client.ApiException;
import com.datadog.api.client.v2.api.OrgGroupsApi;
import com.datadog.api.client.v2.model.GlobalOrgIdentifier;
import com.datadog.api.client.v2.model.OrgGroupMembershipBulkUpdateAttributes;
import com.datadog.api.client.v2.model.OrgGroupMembershipBulkUpdateData;
import com.datadog.api.client.v2.model.OrgGroupMembershipBulkUpdateRelationships;
import com.datadog.api.client.v2.model.OrgGroupMembershipBulkUpdateRequest;
import com.datadog.api.client.v2.model.OrgGroupMembershipBulkUpdateType;
import com.datadog.api.client.v2.model.OrgGroupMembershipListResponse;
import com.datadog.api.client.v2.model.OrgGroupRelationshipToOne;
import com.datadog.api.client.v2.model.OrgGroupRelationshipToOneData;
import com.datadog.api.client.v2.model.OrgGroupType;
import java.util.Collections;
import java.util.UUID;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = ApiClient.getDefaultApiClient();
    defaultClient.setAccessToken(System.getenv("DD_BEARER_TOKEN"));
    defaultClient.setUnstableOperationEnabled("v2.bulkUpdateOrgGroupMemberships", true);
    OrgGroupsApi apiInstance = new OrgGroupsApi(defaultClient);

    OrgGroupMembershipBulkUpdateRequest body =
        new OrgGroupMembershipBulkUpdateRequest()
            .data(
                new OrgGroupMembershipBulkUpdateData()
                    .attributes(
                        new OrgGroupMembershipBulkUpdateAttributes()
                            .orgs(
                                Collections.singletonList(
                                    new GlobalOrgIdentifier()
                                        .orgSite("us1")
                                        .orgUuid(
                                            UUID.fromString(
                                                "c3d4e5f6-a7b8-9012-cdef-012345678901")))))
                    .relationships(
                        new OrgGroupMembershipBulkUpdateRelationships()
                            .sourceOrgGroup(
                                new OrgGroupRelationshipToOne()
                                    .data(
                                        new OrgGroupRelationshipToOneData()
                                            .id(
                                                UUID.fromString(
                                                    "a1b2c3d4-e5f6-7890-abcd-ef0123456789"))
                                            .type(OrgGroupType.ORG_GROUPS)))
                            .targetOrgGroup(
                                new OrgGroupRelationshipToOne()
                                    .data(
                                        new OrgGroupRelationshipToOneData()
                                            .id(
                                                UUID.fromString(
                                                    "a1b2c3d4-e5f6-7890-abcd-ef0123456789"))
                                            .type(OrgGroupType.ORG_GROUPS))))
                    .type(OrgGroupMembershipBulkUpdateType.ORG_GROUP_MEMBERSHIP_BULK_UPDATES));

    try {
      OrgGroupMembershipListResponse result = apiInstance.bulkUpdateOrgGroupMemberships(body);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling OrgGroupsApi#bulkUpdateOrgGroupMemberships");
      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.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comuk1.datadoghq.comddog-gov.comus2.ddog-gov.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" java "Example.java"

// Bulk update org group memberships returns "OK" response
use datadog_api_client::datadog;
use datadog_api_client::datadogV2::api_org_groups::OrgGroupsAPI;
use datadog_api_client::datadogV2::model::GlobalOrgIdentifier;
use datadog_api_client::datadogV2::model::OrgGroupMembershipBulkUpdateAttributes;
use datadog_api_client::datadogV2::model::OrgGroupMembershipBulkUpdateData;
use datadog_api_client::datadogV2::model::OrgGroupMembershipBulkUpdateRelationships;
use datadog_api_client::datadogV2::model::OrgGroupMembershipBulkUpdateRequest;
use datadog_api_client::datadogV2::model::OrgGroupMembershipBulkUpdateType;
use datadog_api_client::datadogV2::model::OrgGroupRelationshipToOne;
use datadog_api_client::datadogV2::model::OrgGroupRelationshipToOneData;
use datadog_api_client::datadogV2::model::OrgGroupType;
use uuid::Uuid;

#[tokio::main]
async fn main() {
    let body = OrgGroupMembershipBulkUpdateRequest::new(OrgGroupMembershipBulkUpdateData::new(
        OrgGroupMembershipBulkUpdateAttributes::new(vec![GlobalOrgIdentifier::new(
            "us1".to_string(),
            Uuid::parse_str("c3d4e5f6-a7b8-9012-cdef-012345678901").expect("invalid UUID"),
        )]),
        OrgGroupMembershipBulkUpdateRelationships::new(
            OrgGroupRelationshipToOne::new(OrgGroupRelationshipToOneData::new(
                Uuid::parse_str("a1b2c3d4-e5f6-7890-abcd-ef0123456789").expect("invalid UUID"),
                OrgGroupType::ORG_GROUPS,
            )),
            OrgGroupRelationshipToOne::new(OrgGroupRelationshipToOneData::new(
                Uuid::parse_str("a1b2c3d4-e5f6-7890-abcd-ef0123456789").expect("invalid UUID"),
                OrgGroupType::ORG_GROUPS,
            )),
        ),
        OrgGroupMembershipBulkUpdateType::ORG_GROUP_MEMBERSHIP_BULK_UPDATES,
    ));
    let mut configuration = datadog::Configuration::new();
    configuration.set_unstable_operation_enabled("v2.bulk_update_org_group_memberships", true);
    let api = OrgGroupsAPI::with_config(configuration);
    let resp = api.bulk_update_org_group_memberships(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.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comuk1.datadoghq.comddog-gov.comus2.ddog-gov.com" DD_API_KEY="<API-KEY>" DD_APP_KEY="<APP-KEY>" cargo run

/**
 * Bulk update org group memberships 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,
    },
  },
});
configuration.unstableOperations["v2.bulkUpdateOrgGroupMemberships"] = true;
const apiInstance = new v2.OrgGroupsApi(configuration);

const params: v2.OrgGroupsApiBulkUpdateOrgGroupMembershipsRequest = {
  body: {
    data: {
      attributes: {
        orgs: [
          {
            orgSite: "us1",
            orgUuid: "c3d4e5f6-a7b8-9012-cdef-012345678901",
          },
        ],
      },
      relationships: {
        sourceOrgGroup: {
          data: {
            id: "a1b2c3d4-e5f6-7890-abcd-ef0123456789",
            type: "org_groups",
          },
        },
        targetOrgGroup: {
          data: {
            id: "a1b2c3d4-e5f6-7890-abcd-ef0123456789",
            type: "org_groups",
          },
        },
      },
      type: "org_group_membership_bulk_updates",
    },
  },
};

apiInstance
  .bulkUpdateOrgGroupMemberships(params)
  .then((data: v2.OrgGroupMembershipListResponse) => {
    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.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comuk1.datadoghq.comddog-gov.comus2.ddog-gov.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" tsc "example.ts"

Bulk update org group memberships

Overview

Request

Body Data (required)

Response

Code Example

Bulk update org group memberships

Bulk update org group memberships

Instructions

Bulk update org group memberships

Instructions

Bulk update org group memberships

Instructions

Bulk update org group memberships

Instructions

Bulk update org group memberships

Instructions

Bulk update org group memberships

Instructions

How can I help you today?