role_users

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

Overview

Name	role_users
Type	Resource
Id	datadog.organization.role_users

Fields

The following fields are returned by SELECT queries:

list_role_users

Name	Datatype	Description
id	string	ID of the user.
attributes	object	Attributes of user object returned by the API.
relationships	object	Relationships of the user object returned by the API.
type	string	Users resource type. (users) (default: users, example: users)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_role_users	select	role_id	page[size], page[number], sort, filter	Gets all users of a role.
add_user_to_role	insert	role_id, data		Adds a user to a role.
remove_user_from_role	delete	role_id		Removes a user from a role.

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
role_id	string	The unique identifier of the role.
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	string	Filter all users by the given string. Defaults to no filtering.
page[number]	integer (int64)	Specific page number to return.
page[size]	integer (int64)	Number of items to return per page. The maximum allowed value is 100.
sort	string	User attribute to order results by. Sort order is ascending by default. Sort order is descending if the field is prefixed by a negative sign, for example sort=-name. Options: name, email, status.

SELECT examples

list_role_users

Gets all users of a role.

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

INSERT examples

add_user_to_role

Adds a user to a role.

INSERT INTO datadog.organization.role_users (
data,
role_id
)
SELECT 
'{{ data }}' /* required */,
'{{ role_id }}'
RETURNING
data,
included,
meta
;

Manifest

# Description fields are for documentation purposes
- name: role_users
props:
  - name: role_id
    value: "{{ role_id }}"
    description: Required parameter for the role_users resource.
  - name: data
    description: |
      Relationship to user object.
    value:
      id: "{{ id }}"
      type: "{{ type }}"

DELETE examples

remove_user_from_role

Removes a user from a role.

DELETE FROM datadog.organization.role_users
WHERE role_id = '{{ role_id }}' --required
;