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. (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,region | Returns a list of all permissions for a single role. | |
| add_permission_to_role | insert | role_id,region | Adds a permission to a role. | |
| remove_permission_from_role | delete | role_id,region | Removes a permission from a role. | |
| remove_user_from_role | delete | role_id,region | 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 | 
|---|---|---|
| region | string | (default: datadoghq.com) | 
| role_id | string | The unique identifier of the role. | 
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
AND region = '{{ region }}' -- required
;
INSERT examples
- add_permission_to_role
- Manifest
Adds a permission to a role.
INSERT INTO datadog.organization.role_permissions (
data__data,
role_id,
region
)
SELECT 
'{{ data }}',
'{{ role_id }}',
'{{ region }}'
RETURNING
data
;
# Description fields are for documentation purposes
- name: role_permissions
  props:
    - name: role_id
      value: string
      description: Required parameter for the role_permissions resource.
    - name: region
      value: string
      description: Required parameter for the role_permissions resource.
    - name: data
      value: object
      description: |
        Relationship to permission object.
DELETE examples
- remove_permission_from_role
- remove_user_from_role
Removes a permission from a role.
DELETE FROM datadog.organization.role_permissions
WHERE role_id = '{{ role_id }}' --required
AND region = '{{ region }}' --required
;
Removes a user from a role.
DELETE FROM datadog.organization.role_permissions
WHERE role_id = '{{ role_id }}' --required
AND region = '{{ region }}' --required
;