permission_groups

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

Overview

Name	permission_groups
Type	Resource
Id	cloudflare.user.permission_groups

Fields

The following fields are returned by SELECT queries:

list

List Token Permission Groups response

Name	Datatype	Description
id	string	Public ID.
name	string	Permission Group Name
scopes	array	Resources to which the Permission Group is scoped

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list	select		name, scope	Find all available permission groups for API Tokens.

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
name	string	Filter by the name of the permission group. The value must be URL-encoded.
scope	string	Filter by the scope of the permission group. The value must be URL-encoded.

SELECT examples

list

Find all available permission groups for API Tokens.

SELECT
id,
name,
scopes
FROM cloudflare.user.permission_groups
WHERE name = '{{ name }}'
AND scope = '{{ scope }}'
;