permissions

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

Overview

Name	permissions
Type	Resource
Id	cloudflare.cloudforce_one.permissions

Fields

The following fields are returned by SELECT queries:

list

Returns the list of permissions.

Name	Datatype	Description
createdAt	string (date-time)
resourceId	string	The resource ID this permission applies to account_id or group_id
resourceType	string	(dataset)
role	string	(read, write)
subjectId	string
subjectType	string	(account, group)
updatedAt	string (date-time)
uuid	string

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list	select	account_id, dataset_id		List permissions
post_permission_create	insert	account_id, dataset_id, subjectType, subjectId, role		Create a permission
put_permission_update	replace	account_id, dataset_id, grant_id, role		Update a permission
delete_permission_delete	delete	account_id, dataset_id, grant_id		Delete a permission

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
account_id	string	The Cloudflare account ID.
dataset_id	string	The dataset ID.
grant_id	string

SELECT examples

list

List permissions

SELECT
createdAt,
resourceId,
resourceType,
role,
subjectId,
subjectType,
updatedAt,
uuid
FROM cloudflare.cloudforce_one.permissions
WHERE account_id = '{{ account_id }}' -- required
AND dataset_id = '{{ dataset_id }}' -- required
;

INSERT examples

post_permission_create

Create a permission

INSERT INTO cloudflare.cloudforce_one.permissions (
role,
subjectId,
subjectType,
account_id,
dataset_id
)
SELECT 
'{{ role }}' /* required */,
'{{ subjectId }}' /* required */,
'{{ subjectType }}' /* required */,
'{{ account_id }}',
'{{ dataset_id }}'
RETURNING
createdAt,
resourceId,
resourceType,
role,
subjectId,
subjectType,
updatedAt,
uuid
;

Manifest

# Description fields are for documentation purposes
- name: permissions
props:
  - name: account_id
    value: "{{ account_id }}"
    description: Required parameter for the permissions resource.
  - name: dataset_id
    value: "{{ dataset_id }}"
    description: Required parameter for the permissions resource.
  - name: role
    value: "{{ role }}"
    valid_values: ['read', 'write']
  - name: subjectId
    value: "{{ subjectId }}"
  - name: subjectType
    value: "{{ subjectType }}"
    valid_values: ['account', 'group']

REPLACE examples

put_permission_update

Update a permission

REPLACE cloudflare.cloudforce_one.permissions
SET 
role = '{{ role }}'
WHERE 
account_id = '{{ account_id }}' --required
AND dataset_id = '{{ dataset_id }}' --required
AND grant_id = '{{ grant_id }}' --required
AND role = '{{ role }}' --required
RETURNING
message,
success;

DELETE examples

delete_permission_delete

Delete a permission

DELETE FROM cloudflare.cloudforce_one.permissions
WHERE account_id = '{{ account_id }}' --required
AND dataset_id = '{{ dataset_id }}' --required
AND grant_id = '{{ grant_id }}' --required
;