role_permissions

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

Overview

Name	role_permissions
Type	Resource
Id	datadog.organization.role_permissions

Fields

The following fields are returned by SELECT queries:

list_role_permissions

Name	Datatype	Description
id	string	ID of the permission.
attributes	object	Attributes of a permission.
type	string	Permissions resource type. (permissions) (default: permissions, example: permissions)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_role_permissions	select	role_id		Returns a list of all permissions for a single role.
add_permission_to_role	insert	role_id		Adds a permission to a role.
remove_permission_from_role	delete	role_id		Removes a permission 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.

SELECT examples

list_role_permissions

Returns a list of all permissions for a single role.

SELECT
id,
attributes,
type
FROM datadog.organization.role_permissions
WHERE role_id = '{{ role_id }}' -- required
;

INSERT examples

add_permission_to_role

Adds a permission to a role.

INSERT INTO datadog.organization.role_permissions (
data,
role_id
)
SELECT 
'{{ data }}',
'{{ role_id }}'
RETURNING
data
;

Manifest

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

DELETE examples

remove_permission_from_role

Removes a permission from a role.

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