org_group_memberships

Creates, updates, deletes, gets or lists an org_group_memberships resource.

Overview

Name	org_group_memberships
Type	Resource
Id	datadog.organization.org_group_memberships

Fields

The following fields are returned by SELECT queries:

get_org_group_membership

Name	Datatype	Description
id	string (uuid)	The ID of the org group membership. (example: f1e2d3c4-b5a6-7890-1234-567890abcdef)
attributes	object	Attributes of an org group membership.
relationships	object	Relationships of an org group membership.
type	string	Org group memberships resource type. (org_group_memberships) (example: org_group_memberships)

list_org_group_memberships

Name	Datatype	Description
id	string (uuid)	The ID of the org group membership. (example: f1e2d3c4-b5a6-7890-1234-567890abcdef)
attributes	object	Attributes of an org group membership.
relationships	object	Relationships of an org group membership.
type	string	Org group memberships resource type. (org_group_memberships) (example: org_group_memberships)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_org_group_membership	select	org_group_membership_id		Get a specific organization group membership by its ID.
list_org_group_memberships	select		filter[org_group_id], filter[org_uuid], page[number], page[size], sort	List organization group memberships. Filter by org group ID or org UUID. At least one of filter[org_group_id] or filter[org_uuid] must be provided. When filtering by org UUID, returns a single-item list with the membership for that org.
update_org_group_membership	update	org_group_membership_id, data		Move an organization to a different org group by updating its membership.
bulk_update_org_group_memberships	exec	data		Move a batch of organizations from one org group to another. This is an atomic operation. Maximum 100 orgs per request.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
org_group_membership_id	string (uuid)	The ID of the org group membership.
site	string	The Datadog site (region) for your organization, for example datadoghq.com, us3.datadoghq.com, us5.datadoghq.com, ap1.datadoghq.com, ap2.datadoghq.com, datadoghq.eu, ddog-gov.com. Resolved from the DD_SITE environment variable when set. Optional: defaults to datadoghq.com, or the value of the DD_SITE environment variable when set; a WHERE value overrides both.
filter[org_group_id]	string (uuid)	Filter memberships by org group ID. Required when filter[org_uuid] is not provided.
filter[org_uuid]	string (uuid)	Filter memberships by org UUID. Returns a single-item list.
page[number]	integer (int64)	The page number to return.
page[size]	integer (int64)	The number of items per page. Maximum is 1000.
sort	string	Field to sort memberships by. Supported values: name, uuid, -name, -uuid. Defaults to uuid.

SELECT examples

get_org_group_membership

Get a specific organization group membership by its ID.

SELECT
id,
attributes,
relationships,
type
FROM datadog.organization.org_group_memberships
WHERE org_group_membership_id = '{{ org_group_membership_id }}' -- required
;

list_org_group_memberships

List organization group memberships. Filter by org group ID or org UUID. At least one of filter[org_group_id] or filter[org_uuid] must be provided. When filtering by org UUID, returns a single-item list with the membership for that org.

SELECT
id,
attributes,
relationships,
type
FROM datadog.organization.org_group_memberships
WHERE filter[org_group_id] = '{{ filter[org_group_id] }}'
AND filter[org_uuid] = '{{ filter[org_uuid] }}'
AND page[number] = '{{ page[number] }}'
AND page[size] = '{{ page[size] }}'
AND sort = '{{ sort }}'
;

UPDATE examples

update_org_group_membership

Move an organization to a different org group by updating its membership.

UPDATE datadog.organization.org_group_memberships
SET 
data = '{{ data }}'
WHERE 
org_group_membership_id = '{{ org_group_membership_id }}' --required
AND data = '{{ data }}' --required
RETURNING
data;

Lifecycle Methods

EXEC variables use wire (API) names.

bulk_update_org_group_memberships

Move a batch of organizations from one org group to another. This is an atomic operation. Maximum 100 orgs per request.

EXEC datadog.organization.org_group_memberships.bulk_update_org_group_memberships 
@@json=
'{
"data": "{{ data }}"
}'
;