members

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

Overview

Name	members
Type	Resource
Id	cloudflare.iam.members

Fields

The following fields are returned by SELECT queries:

get

Get User Group Member response

Name	Datatype	Description
id	string	Account member identifier. (example: 4f5f0c14a2a41d5063dd301b2f829f04)
created_at	string (date-time)	When the member was added to the user group. (example: 2026-01-15T10:30:00Z)
email	string	The contact email address of the user. (example: user@example.com)
status	string	The member's status in the account. (accepted, pending) (example: accepted)
user	object	Details of the user associated with this membership.

list

List User Group Members

Name	Datatype	Description
id	string	Account member identifier. (example: 4f5f0c14a2a41d5063dd301b2f829f04)
email	string	The contact email address of the user. (example: user@example.com)
status	string	The member's status in the account. (accepted, pending) (example: accepted)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	account_id, user_group_id, member_id		Get details of a specific member in a user group.
list	select	account_id, user_group_id	page, per_page, fuzzyEmail, direction	List all the members attached to a user group.
account_user_group_member_create	insert	account_id, user_group_id		Add members to a User Group.
account_user_group_members_update	replace	account_id, user_group_id		Replace the set of members attached to a User Group.
delete	delete	account_id, user_group_id, member_id		Remove a member from User Group

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.
member_id	string	The account member ID.
user_group_id	string
direction	string
fuzzyEmail	string
page	number
per_page	number

SELECT examples

get

Get details of a specific member in a user group.

SELECT
id,
created_at,
email,
status,
user
FROM cloudflare.iam.members
WHERE account_id = '{{ account_id }}' -- required
AND user_group_id = '{{ user_group_id }}' -- required
AND member_id = '{{ member_id }}' -- required
;

list

List all the members attached to a user group.

SELECT
id,
email,
status
FROM cloudflare.iam.members
WHERE account_id = '{{ account_id }}' -- required
AND user_group_id = '{{ user_group_id }}' -- required
AND page = '{{ page }}'
AND per_page = '{{ per_page }}'
AND fuzzyEmail = '{{ fuzzyEmail }}'
AND direction = '{{ direction }}'
;

INSERT examples

account_user_group_member_create

Add members to a User Group.

INSERT INTO cloudflare.iam.members (
account_id,
user_group_id
)
SELECT 
'{{ account_id }}',
'{{ user_group_id }}'
RETURNING
errors,
messages,
result,
success
;

Manifest

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

REPLACE examples

account_user_group_members_update

Replace the set of members attached to a User Group.

REPLACE cloudflare.iam.members
SET 
-- No updatable properties
WHERE 
account_id = '{{ account_id }}' --required
AND user_group_id = '{{ user_group_id }}' --required
RETURNING
errors,
messages,
result,
success;

DELETE examples

delete

Remove a member from User Group

DELETE FROM cloudflare.iam.members
WHERE account_id = '{{ account_id }}' --required
AND user_group_id = '{{ user_group_id }}' --required
AND member_id = '{{ member_id }}' --required
;