team_memberships

Creates, updates, deletes, gets or lists a team_memberships resource.

Overview

Name	team_memberships
Type	Resource
Id	datadog.organization.team_memberships

Fields

The following fields are returned by SELECT queries:

get_team_memberships

Represents a user's association to a team

Name	Datatype	Description
id	string	The ID of a user's relationship with a team (example: TeamMembership-aeadc05e-98a8-11ec-ac2c-da7ad0900001-38835)
attributes	object	Team membership attributes
relationships	object	Relationship between membership and a user
type	string	Team membership type (default: team_memberships, example: team_memberships)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_team_memberships	select	team_id, region	page[size], page[number], sort, filter[keyword]	Get a paginated list of members for a team
create_team_membership	insert	team_id, region, data__data		Add a user to a team.
update_team_membership	update	team_id, user_id, region, data__data		Update a user's membership attributes on a team.
delete_team_membership	delete	team_id, user_id, region		Remove a user from a team.

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
region	string	(default: datadoghq.com)
team_id	string	None
user_id	string	None
filter[keyword]	string	Search query, can be user email or name
page[number]	integer (int64)	Specific page number to return.
page[size]	integer (int64)	Size for a given page. The maximum allowed value is 100.
sort	string	Specifies the order of returned team memberships

SELECT examples

get_team_memberships

Get a paginated list of members for a team

SELECT
id,
attributes,
relationships,
type
FROM datadog.organization.team_memberships
WHERE team_id = '{{ team_id }}' -- required
AND region = '{{ region }}' -- required
AND page[size] = '{{ page[size] }}'
AND page[number] = '{{ page[number] }}'
AND sort = '{{ sort }}'
AND filter[keyword] = '{{ filter[keyword] }}'
;

INSERT examples

create_team_membership

Add a user to a team.

INSERT INTO datadog.organization.team_memberships (
data__data,
team_id,
region
)
SELECT 
'{{ data }}' /* required */,
'{{ team_id }}',
'{{ region }}'
RETURNING
data,
included
;

Manifest

# Description fields are for documentation purposes
- name: team_memberships
  props:
    - name: team_id
      value: string
      description: Required parameter for the team_memberships resource.
    - name: region
      value: string
      description: Required parameter for the team_memberships resource.
    - name: data
      value: object
      description: |
        A user's relationship with a team

UPDATE examples

update_team_membership

Update a user's membership attributes on a team.

UPDATE datadog.organization.team_memberships
SET 
data__data = '{{ data }}'
WHERE 
team_id = '{{ team_id }}' --required
AND user_id = '{{ user_id }}' --required
AND region = '{{ region }}' --required
AND data__data = '{{ data }}' --required
RETURNING
data,
included;

DELETE examples

delete_team_membership

Remove a user from a team.

DELETE FROM datadog.organization.team_memberships
WHERE team_id = '{{ team_id }}' --required
AND user_id = '{{ user_id }}' --required
AND region = '{{ region }}' --required
;