shared_dashboard_invitations

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

Overview

Name	shared_dashboard_invitations
Type	Resource
Id	datadog.dashboards.shared_dashboard_invitations

Fields

The following fields are returned by SELECT queries:

get_public_dashboard_invitations

Name	Datatype	Description
attributes	object	Attributes of the shared dashboard invitation
type	string	Type for shared dashboard invitation request body. (public_dashboard_invitation) (example: public_dashboard_invitation)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_public_dashboard_invitations	select	token	page_size, page_number	Describe the invitations that exist for the given shared dashboard (paginated).
send_public_dashboard_invitation	insert	token, data		Send emails to specified email addresses containing links to access a given authenticated shared dashboard. Email addresses must already belong to the authenticated shared dashboard's share_list.
delete_public_dashboard_invitation	delete	token		Revoke previously sent invitation emails and active sessions used to access a given shared dashboard for specific email addresses.

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.
token	string	The token of the shared dashboard.
page_number	integer (int64)	The page to access (base 0).
page_size	integer (int64)	The number of records to return in a single request.

SELECT examples

get_public_dashboard_invitations

Describe the invitations that exist for the given shared dashboard (paginated).

SELECT
attributes,
type
FROM datadog.dashboards.shared_dashboard_invitations
WHERE token = '{{ token }}' -- required
AND page_size = '{{ page_size }}'
AND page_number = '{{ page_number }}'
;

INSERT examples

send_public_dashboard_invitation

Send emails to specified email addresses containing links to access a given authenticated shared dashboard. Email addresses must already belong to the authenticated shared dashboard's share_list.

INSERT INTO datadog.dashboards.shared_dashboard_invitations (
data,
token
)
SELECT 
'{{ data }}' /* required */,
'{{ token }}'
RETURNING
data,
meta
;

Manifest

# Description fields are for documentation purposes
- name: shared_dashboard_invitations
props:
  - name: token
    value: "{{ token }}"
    description: Required parameter for the shared_dashboard_invitations resource.
  - name: data
    description: |
      An object or list of objects containing the information for an invitation to a shared dashboard.
    value:
      attributes:
        created_at: "{{ created_at }}"
        email: "{{ email }}"
        has_session: {{ has_session }}
        invitation_expiry: "{{ invitation_expiry }}"
        session_expiry: "{{ session_expiry }}"
        share_token: "{{ share_token }}"
      type: "{{ type }}"

DELETE examples

delete_public_dashboard_invitation

Revoke previously sent invitation emails and active sessions used to access a given shared dashboard for specific email addresses.

DELETE FROM datadog.dashboards.shared_dashboard_invitations
WHERE token = '{{ token }}' --required
;