members

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

Overview

Name	members
Type	Resource
Id	netlify.accounts.members

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string
full_name	string
avatar	string
email	string
role	string

list

Name	Datatype	Description
id	string
full_name	string
avatar	string
email	string
role	string

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	account_slug, member_id
list	select	account_slug
add	insert	account_slug
update	replace	account_slug, member_id
remove	delete	account_slug, member_id

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_slug	string
member_id	string

SELECT examples

get

OK

SELECT
id,
full_name,
avatar,
email,
role
FROM netlify.accounts.members
WHERE account_slug = '{{ account_slug }}' -- required
AND member_id = '{{ member_id }}' -- required
;

list

OK

SELECT
id,
full_name,
avatar,
email,
role
FROM netlify.accounts.members
WHERE account_slug = '{{ account_slug }}' -- required
;

INSERT examples

add

No description available.

INSERT INTO netlify.accounts.members (
role,
email,
account_slug
)
SELECT 
'{{ role }}',
'{{ email }}',
'{{ account_slug }}'
RETURNING
id,
full_name,
avatar,
email,
role
;

Manifest

# Description fields are for documentation purposes
- name: members
props:
  - name: account_slug
    value: "{{ account_slug }}"
    description: Required parameter for the members resource.
  - name: role
    value: "{{ role }}"
    valid_values: ['Owner', 'Developer', 'Billing Admin', 'Reviewer']
  - name: email
    value: "{{ email }}"

REPLACE examples

update

No description available.

REPLACE netlify.accounts.members
SET 
role = '{{ role }}',
site_access = '{{ site_access }}',
site_ids = '{{ site_ids }}'
WHERE 
account_slug = '{{ account_slug }}' --required
AND member_id = '{{ member_id }}' --required
RETURNING
id,
full_name,
avatar,
email,
role;

DELETE examples

remove

No description available.

DELETE FROM netlify.accounts.members
WHERE account_slug = '{{ account_slug }}' --required
AND member_id = '{{ member_id }}' --required
;