groups

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

Overview

Name	groups
Type	Resource
Id	cloudflare.cloudforce_one.groups

Fields

The following fields are returned by SELECT queries:

get

Return the group.

Name	Datatype	Description
name	string
createdAt	string (date-time)
description	string
members	array
updatedAt	string (date-time)
uuid	string

list

Returns the list of groups.

Name	Datatype	Description
name	string
createdAt	string (date-time)
description	string
updatedAt	string (date-time)
uuid	string

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	account_id, group_id		Read a group for an account
list	select	account_id		List groups for an account
post_group_create	insert	account_id, name, description		Create a group
put_group_update	replace	account_id, group_id, name, description		Update a group
delete_group_delete	delete	account_id, group_id		Delete a group 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.
group_id	string	The Access group ID.

SELECT examples

get

Read a group for an account

SELECT
name,
createdAt,
description,
members,
updatedAt,
uuid
FROM cloudflare.cloudforce_one.groups
WHERE account_id = '{{ account_id }}' -- required
AND group_id = '{{ group_id }}' -- required
;

list

List groups for an account

SELECT
name,
createdAt,
description,
updatedAt,
uuid
FROM cloudflare.cloudforce_one.groups
WHERE account_id = '{{ account_id }}' -- required
;

INSERT examples

post_group_create

Create a group

INSERT INTO cloudflare.cloudforce_one.groups (
description,
name,
account_id
)
SELECT 
'{{ description }}' /* required */,
'{{ name }}' /* required */,
'{{ account_id }}'
RETURNING
name,
createdAt,
description,
updatedAt,
uuid
;

Manifest

# Description fields are for documentation purposes
- name: groups
props:
  - name: account_id
    value: "{{ account_id }}"
    description: Required parameter for the groups resource.
  - name: description
    value: "{{ description }}"
  - name: name
    value: "{{ name }}"

REPLACE examples

put_group_update

Update a group

REPLACE cloudflare.cloudforce_one.groups
SET 
description = '{{ description }}',
name = '{{ name }}'
WHERE 
account_id = '{{ account_id }}' --required
AND group_id = '{{ group_id }}' --required
AND name = '{{ name }}' --required
AND description = '{{ description }}' --required
RETURNING
name,
createdAt,
description,
updatedAt,
uuid;

DELETE examples

delete_group_delete

Delete a group for an account

DELETE FROM cloudflare.cloudforce_one.groups
WHERE account_id = '{{ account_id }}' --required
AND group_id = '{{ group_id }}' --required
;