access_group_projects

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

Overview

Name	access_group_projects
Type	Resource
Id	vercel.access_groups.access_group_projects

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
access_group_id	string	(wire: accessGroupId)
project_id	string	(wire: projectId)
team_id	string	(wire: teamId)
created_at	string	(wire: createdAt)
role	string	(ADMIN, PROJECT_DEVELOPER, PROJECT_GUEST, PROJECT_VIEWER)
updated_at	string	(wire: updatedAt)

list

Name	Datatype	Description
project_id	string	(wire: projectId)
created_at	string	(wire: createdAt)
project	object
role	string	(ADMIN, PROJECT_DEVELOPER, PROJECT_GUEST, PROJECT_VIEWER)
updated_at	string	(wire: updatedAt)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	access_group_id_or_name, project_id	team_id, slug	Allows reading an access group project
list	select	id_or_name	limit, next, team_id, slug	List projects of an access group
create	insert	access_group_id_or_name, role, project_id	team_id, slug	Allows creation of an access group project
update	update	access_group_id_or_name, project_id, role	team_id, slug	Allows update of an access group project
delete	delete	access_group_id_or_name, project_id	team_id, slug	Allows deletion of an access group project

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
access_group_id_or_name	string
id_or_name	string	The ID or name of the Access Group.
project_id	string	(example: prj_ndlgr43fadlPyCtREAqxxdyFK)
limit	integer	Limit how many access group projects should be returned.
next	string	Continuation cursor to retrieve the next page of results.
slug	string	The Team slug to perform the request on behalf of.
team_id	string	The Team identifier to perform the request on behalf of. (wire: teamId)

SELECT examples

get

Allows reading an access group project

SELECT
access_group_id,
project_id,
team_id,
created_at,
role,
updated_at
FROM vercel.access_groups.access_group_projects
WHERE access_group_id_or_name = '{{ access_group_id_or_name }}' -- required
AND project_id = '{{ project_id }}' -- required
AND team_id = '{{ team_id }}'
AND slug = '{{ slug }}'
;

list

List projects of an access group

SELECT
project_id,
created_at,
project,
role,
updated_at
FROM vercel.access_groups.access_group_projects
WHERE id_or_name = '{{ id_or_name }}' -- required
AND limit = '{{ limit }}'
AND next = '{{ next }}'
AND team_id = '{{ team_id }}'
AND slug = '{{ slug }}'
;

INSERT examples

create

Allows creation of an access group project

INSERT INTO vercel.access_groups.access_group_projects (
project_id,
role,
access_group_id_or_name,
team_id,
slug
)
SELECT 
'{{ project_id }}' /* required */,
'{{ role }}' /* required */,
'{{ access_group_id_or_name }}',
'{{ team_id }}',
'{{ slug }}'
RETURNING
access_group_id,
project_id,
team_id,
created_at,
role,
updated_at
;

Manifest

# Description fields are for documentation purposes
- name: access_group_projects
props:
  - name: access_group_id_or_name
    value: "{{ access_group_id_or_name }}"
    description: Required parameter for the access_group_projects resource.
  - name: project_id
    value: "{{ project_id }}"
    description: |
      The ID of the project.
  - name: role
    value: "{{ role }}"
    description: |
      The project role that will be added to this Access Group.
    valid_values: ['ADMIN', 'PROJECT_VIEWER', 'PROJECT_DEVELOPER']
  - name: team_id
    value: "{{ team_id }}"
    description: The Team identifier to perform the request on behalf of.
    description: The Team identifier to perform the request on behalf of.
  - name: slug
    value: "{{ slug }}"
    description: The Team slug to perform the request on behalf of.
    description: The Team slug to perform the request on behalf of.

UPDATE examples

update

Allows update of an access group project

UPDATE vercel.access_groups.access_group_projects
SET 
role = '{{ role }}'
WHERE 
access_group_id_or_name = '{{ access_group_id_or_name }}' --required
AND project_id = '{{ project_id }}' --required
AND role = '{{ role }}' --required
AND team_id = '{{ team_id}}'
AND slug = '{{ slug}}'
RETURNING
access_group_id,
project_id,
team_id,
created_at,
role,
updated_at;

DELETE examples

delete

Allows deletion of an access group project

DELETE FROM vercel.access_groups.access_group_projects
WHERE access_group_id_or_name = '{{ access_group_id_or_name }}' --required
AND project_id = '{{ project_id }}' --required
AND team_id = '{{ team_id }}'
AND slug = '{{ slug }}'
;