access_groups

Creates, updates, deletes, gets or lists an access_groups resource.

Overview

Name	access_groups
Type	Resource
Id	cloudflare.zero_trust.access_groups

Fields

The following fields are returned by SELECT queries:

list_by_account

List Access groups response

Name	Datatype	Description
id	string	UUID. (example: f174e90a-fafe-4643-bbbc-4a0ed4fc8415)
name	string	The name of the Access group. (example: Allow devs)
created_at	string (date-time)	(example: 2014-01-01T05:20:00.12345Z)
exclude	array	Rules evaluated with a NOT logical operator. To match a policy, a user cannot meet any of the Exclude rules.
include	array	Rules evaluated with an OR logical operator. A user needs to meet only one of the Include rules.
is_default	array	Rules evaluated with an AND logical operator. To match a policy, a user must meet all of the Require rules.
require	array	Rules evaluated with an AND logical operator. To match a policy, a user must meet all of the Require rules.
updated_at	string (date-time)	(example: 2014-01-01T05:20:00.12345Z)

list_by_zone

List Access groups response

Name	Datatype	Description
id	string	UUID. (example: f174e90a-fafe-4643-bbbc-4a0ed4fc8415)
name	string	The name of the Access group. (example: Allow devs)
created_at	string (date-time)	(example: 2014-01-01T05:20:00.12345Z)
exclude	array	Rules evaluated with a NOT logical operator. To match a policy, a user cannot meet any of the Exclude rules.
include	array	Rules evaluated with an OR logical operator. A user needs to meet only one of the Include rules.
is_default	array	Rules evaluated with an AND logical operator. To match a policy, a user must meet all of the Require rules.
require	array	Rules evaluated with an AND logical operator. To match a policy, a user must meet all of the Require rules.
updated_at	string (date-time)	(example: 2014-01-01T05:20:00.12345Z)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_by_account	select	account_id	name, search, page, per_page	Lists all Access groups.
list_by_zone	select	zone_id	name, search, page, per_page	Lists all Access groups.

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.
zone_id	string	The Cloudflare zone ID.
name	string
page	integer
per_page	integer
search	string

SELECT examples

list_by_account

Lists all Access groups.

SELECT
id,
name,
created_at,
exclude,
include,
is_default,
require,
updated_at
FROM cloudflare.zero_trust.access_groups
WHERE account_id = '{{ account_id }}' -- required
AND name = '{{ name }}'
AND search = '{{ search }}'
AND page = '{{ page }}'
AND per_page = '{{ per_page }}'
;

list_by_zone

Lists all Access groups.

SELECT
id,
name,
created_at,
exclude,
include,
is_default,
require,
updated_at
FROM cloudflare.zero_trust.access_groups
WHERE zone_id = '{{ zone_id }}' -- required
AND name = '{{ name }}'
AND search = '{{ search }}'
AND page = '{{ page }}'
AND per_page = '{{ per_page }}'
;