permission_groups

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

Overview

Name	permission_groups
Type	Resource
Id	cloudflare.iam.permission_groups

Fields

The following fields are returned by SELECT queries:

get

Permission Group Details response

Name	Datatype	Description
id	string	Identifier of the permission group. (example: 6d7f2f5f5b1d4a0e9081fdc98d432fd1)
name	string	Name of the permission group. (example: Load Balancer)
meta	object	Attributes associated to the permission group.

list

List Permission Groups response

Name	Datatype	Description
id	string	Identifier of the permission group. (example: 6d7f2f5f5b1d4a0e9081fdc98d432fd1)
name	string	Name of the permission group. (example: Load Balancer)
meta	object	Attributes associated to the permission group.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	account_id, permission_group_id		Get information about a specific permission group in an account.
list	select	account_id	id, name, label, page, per_page	List all the permissions groups for an account.

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.
permission_group_id	string
id	string
label	string
name	string
page	number
per_page	number

SELECT examples

get

Get information about a specific permission group in an account.

SELECT
id,
name,
meta
FROM cloudflare.iam.permission_groups
WHERE account_id = '{{ account_id }}' -- required
AND permission_group_id = '{{ permission_group_id }}' -- required
;

list

List all the permissions groups for an account.

SELECT
id,
name,
meta
FROM cloudflare.iam.permission_groups
WHERE account_id = '{{ account_id }}' -- required
AND id = '{{ id }}'
AND name = '{{ name }}'
AND label = '{{ label }}'
AND page = '{{ page }}'
AND per_page = '{{ per_page }}'
;