members

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

Overview

Name	members
Type	Resource
Id	cloudflare.accounts.members

Fields

The following fields are returned by SELECT queries:

get

Member Details response

Name	Datatype	Description
id	string	Membership identifier tag. (example: 4536bcfad5faccb111b47003c79917fa)
email	string	The contact email address of the user. (example: user@example.com)
policies	array	Access policy for the membership
roles	array	Roles assigned to this Member.
status	string	A member's status in the account. (accepted, pending) (example: accepted)
user	object	Details of the user associated to the membership.

list

List Members response

Name	Datatype	Description
id	string	Membership identifier tag. (example: 4536bcfad5faccb111b47003c79917fa)
email	string	The contact email address of the user. (example: user@example.com)
policies	array	Access policy for the membership
roles	array	Roles assigned to this Member.
status	string	A member's status in the account. (accepted, pending) (example: accepted)
user	object	Details of the user associated to the membership.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	member_id, account_id		Get information about a specific member of an account.
list	select	account_id	order, status, page, per_page, direction	List all members of an account.
create	insert	account_id, email		Add a user to the list of members for this account.
update	replace	member_id, account_id, policies		Modify an account member.
delete	delete	member_id, account_id		Remove a member from 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.
member_id	string	The account member ID.
direction	string
order	string
page	number
per_page	number
status	string

SELECT examples

get

Get information about a specific member of an account.

SELECT
id,
email,
policies,
roles,
status,
user
FROM cloudflare.accounts.members
WHERE member_id = '{{ member_id }}' -- required
AND account_id = '{{ account_id }}' -- required
;

list

List all members of an account.

SELECT
id,
email,
policies,
roles,
status,
user
FROM cloudflare.accounts.members
WHERE account_id = '{{ account_id }}' -- required
AND order = '{{ order }}'
AND status = '{{ status }}'
AND page = '{{ page }}'
AND per_page = '{{ per_page }}'
AND direction = '{{ direction }}'
;

INSERT examples

create

Add a user to the list of members for this account.

INSERT INTO cloudflare.accounts.members (
email,
roles,
status,
policies,
account_id
)
SELECT 
'{{ email }}' /* required */,
'{{ roles }}',
'{{ status }}',
'{{ policies }}',
'{{ account_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: email
    value: "{{ email }}"
    description: |
      The contact email address of the user.
  - name: roles
    value:
      - "{{ roles }}"
    description: |
      Array of roles associated with this member.
  - name: status
    value: "{{ status }}"
    description: |
      Status of the member invitation. If not provided during creation, defaults to 'pending'. Changing from 'accepted' back to 'pending' will trigger a replacement of the member resource in Terraform.
    valid_values: ['accepted', 'pending']
  - name: policies
    description: |
      Array of policies associated with this member.
    value:
      - access: "{{ access }}"
        id: "{{ id }}"
        permission_groups: "{{ permission_groups }}"
        resource_groups: "{{ resource_groups }}"

REPLACE examples

update

Modify an account member.

REPLACE cloudflare.accounts.members
SET 
roles = '{{ roles }}',
policies = '{{ policies }}'
WHERE 
member_id = '{{ member_id }}' --required
AND account_id = '{{ account_id }}' --required
AND policies = '{{ policies }}' --required
RETURNING
errors,
messages,
result,
success;

DELETE examples

delete

Remove a member from an account.

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