invitations

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

Overview

Name	invitations
Type	Resource
Id	datadog.organization.invitations

Fields

The following fields are returned by SELECT queries:

get_invitation

Name	Datatype	Description
id	string	ID of the user invitation.
attributes	object	Attributes of a user invitation.
relationships	object	Relationships data for user invitation.
type	string	User invitations type. (user_invitations) (default: user_invitations, example: user_invitations)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_invitation	select	user_invitation_uuid		Returns a single user invitation by its UUID.
send_invitations	exec	data		Sends emails to one or more users inviting them to join the organization.

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
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.
user_invitation_uuid	string	The UUID of the user invitation.

SELECT examples

get_invitation

Returns a single user invitation by its UUID.

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

Lifecycle Methods

EXEC variables use wire (API) names.

send_invitations

Sends emails to one or more users inviting them to join the organization.

EXEC datadog.organization.invitations.send_invitations 
@@json=
'{
"data": "{{ data }}"
}'
;