access-groups

Reference

Access Groups

Creates an access group

post/v1/access-groups

Allows to create an access group

Optional params

fetch-request

1await fetch("https://api.vercel.com/v1/access-groups?slug=SOME_STRING_VALUE&teamId=SOME_STRING_VALUE", {
2  "body": {
3    "name": "My access group",
4    "membersToAdd": "SOME_ARRAY OF STRING_VALUE",
5    "projects": [
6      {
7        "projectId": "prj_ndlgr43fadlPyCtREAqxxdyFK",
8        "role": "ADMIN"
9      }
10    ]
11  },
12  "headers": {
13    "Authorization": "Bearer <TOKEN>"
14  },
15  "method": "post"
16})

Parameters

Query Params

Body Params

Query Parameter	Description
slug	string The Team slug to perform the request on behalf of.
teamId	string The Team identifier to perform the request on behalf of.

Response

accessGroupIdstringRequired
ID of the access group.
Example: ag_123a6c5209bc3778245d011443644c8d27dc2c50

createdAtstringRequired
Timestamp in milliseconds when the access group was created.
Example: 1588720733602

membersCountnumberRequired

namestringRequired
The name of this access group.
Example: my-access-group

projectsCountnumberRequired

teamIdstringRequired
ID of the team that this access group belongs to.
Example: team_123a6c5209bc3778245d011443644c8d27dc2c50

updatedAtstringRequired
Timestamp in milliseconds when the access group was last updated.
Example: 1588720733602

Response Codes

Code	Description
`200`
`400`	One of the provided values in the request body is invalid.
`401`
`403`	You do not have permission to access this resource.
`404`

Optional params

fetch-request

1await fetch("https://api.vercel.com/v1/access-groups?slug=SOME_STRING_VALUE&teamId=SOME_STRING_VALUE", {
2  "body": {
3    "name": "My access group",
4    "membersToAdd": "SOME_ARRAY OF STRING_VALUE",
5    "projects": [
6      {
7        "projectId": "prj_ndlgr43fadlPyCtREAqxxdyFK",
8        "role": "ADMIN"
9      }
10    ]
11  },
12  "headers": {
13    "Authorization": "Bearer <TOKEN>"
14  },
15  "method": "post"
16})

Create an access group project

post/v1/access-groups/{accessGroupIdOrName}/projects

Allows creation of an access group project

Optional params

fetch-request

1await fetch("https://api.vercel.com/v1/access-groups/SOME_STRING_VALUE/projects?slug=SOME_STRING_VALUE&teamId=SOME_STRING_VALUE", {
2  "body": {
3    "projectId": "prj_ndlgr43fadlPyCtREAqxxdyFK",
4    "role": "ADMIN"
5  },
6  "headers": {
7    "Authorization": "Bearer <TOKEN>"
8  },
9  "method": "post"
10})

Parameters

Path Params

Query Params

Body Params

Path Parameter	Description
accessGroupIdOrName	string required

Response

accessGroupIdstringRequired

createdAtstringRequired

projectIdstringRequired

rolestringRequired
One of: ADMIN | PROJECT_DEVELOPER | PROJECT_VIEWER

teamIdstringRequired

updatedAtstringRequired

Response Codes

Code	Description
`200`
`400`	One of the provided values in the request body is invalid. One of the provided values in the request query is invalid.
`401`
`403`	You do not have permission to access this resource.
`404`

Optional params

fetch-request

1await fetch("https://api.vercel.com/v1/access-groups/SOME_STRING_VALUE/projects?slug=SOME_STRING_VALUE&teamId=SOME_STRING_VALUE", {
2  "body": {
3    "projectId": "prj_ndlgr43fadlPyCtREAqxxdyFK",
4    "role": "ADMIN"
5  },
6  "headers": {
7    "Authorization": "Bearer <TOKEN>"
8  },
9  "method": "post"
10})

Deletes an access group

delete/v1/access-groups/{idOrName}

Allows to delete an access group

Optional params

fetch-request

1await fetch("https://api.vercel.com/v1/access-groups/SOME_STRING_VALUE?slug=SOME_STRING_VALUE&teamId=SOME_STRING_VALUE", {
2  "headers": {
3    "Authorization": "Bearer <TOKEN>"
4  },
5  "method": "delete"
6})

Parameters

Path Params

Query Params

Path Parameter	Description
idOrName	string required

Response

N/A

Response Codes

Code	Description
`200`
`400`	One of the provided values in the request query is invalid.
`401`
`403`	You do not have permission to access this resource.
`404`

Optional params

fetch-request

1await fetch("https://api.vercel.com/v1/access-groups/SOME_STRING_VALUE?slug=SOME_STRING_VALUE&teamId=SOME_STRING_VALUE", {
2  "headers": {
3    "Authorization": "Bearer <TOKEN>"
4  },
5  "method": "delete"
6})

Delete an access group project

delete/v1/access-groups/{accessGroupIdOrName}/projects/{projectId}

Allows deletion of an access group project

Optional params

fetch-request

1await fetch("https://api.vercel.com/v1/access-groups/SOME_STRING_VALUE/projects/SOME_STRING_VALUE?slug=SOME_STRING_VALUE&teamId=SOME_STRING_VALUE", {
2  "headers": {
3    "Authorization": "Bearer <TOKEN>"
4  },
5  "method": "delete"
6})

Parameters

Path Params

Query Params

Path Parameter	Description
accessGroupIdOrName	string required
projectId	string required

Response

N/A

Response Codes

Code	Description
`200`
`400`	One of the provided values in the request query is invalid.
`401`
`403`	You do not have permission to access this resource.
`404`

Optional params

fetch-request

1await fetch("https://api.vercel.com/v1/access-groups/SOME_STRING_VALUE/projects/SOME_STRING_VALUE?slug=SOME_STRING_VALUE&teamId=SOME_STRING_VALUE", {
2  "headers": {
3    "Authorization": "Bearer <TOKEN>"
4  },
5  "method": "delete"
6})

List members of an access group

get/v1/access-groups/{idOrName}/members

List members of an access group

Optional params

fetch-request

1await fetch("https://api.vercel.com/v1/access-groups/ag_pavWOn1iLObbXLRiwVvzmPrTWyTf/members?limit=20&next=SOME_STRING_VALUE&search=SOME_STRING_VALUE&slug=SOME_STRING_VALUE&teamId=SOME_STRING_VALUE", {
2  "headers": {
3    "Authorization": "Bearer <TOKEN>"
4  },
5  "method": "get"
6})

Parameters

Path Params

Query Params

Path Parameter	Description
idOrName	string required The ID or name of the Access Group. Example:`ag_pavWOn1iLObbXLRiwVvzmPrTWyTf`

Response

membersarrayRequired
Properties
paginationobjectRequired

Properties

Response Codes

Code	Description
`200`
`400`	One of the provided values in the request query is invalid.
`401`
`403`	You do not have permission to access this resource.
`404`

Optional params

fetch-request

1await fetch("https://api.vercel.com/v1/access-groups/ag_pavWOn1iLObbXLRiwVvzmPrTWyTf/members?limit=20&next=SOME_STRING_VALUE&search=SOME_STRING_VALUE&slug=SOME_STRING_VALUE&teamId=SOME_STRING_VALUE", {
2  "headers": {
3    "Authorization": "Bearer <TOKEN>"
4  },
5  "method": "get"
6})

List projects of an access group

get/v1/access-groups/{idOrName}/projects

List projects of an access group

Optional params

fetch-request

1await fetch("https://api.vercel.com/v1/access-groups/ag_pavWOn1iLObbXLRiwVvzmPrTWyTf/projects?limit=20&next=SOME_STRING_VALUE&slug=SOME_STRING_VALUE&teamId=SOME_STRING_VALUE", {
2  "headers": {
3    "Authorization": "Bearer <TOKEN>"
4  },
5  "method": "get"
6})

Parameters

Path Params

Query Params

Path Parameter	Description
idOrName	string required The ID or name of the Access Group. Example:`ag_pavWOn1iLObbXLRiwVvzmPrTWyTf`

Response

paginationobjectRequired

Properties
projectsarrayRequired
Properties

Response Codes

Code	Description
`200`
`400`	One of the provided values in the request query is invalid.
`401`
`403`	You do not have permission to access this resource.
`404`

Optional params

fetch-request

1await fetch("https://api.vercel.com/v1/access-groups/ag_pavWOn1iLObbXLRiwVvzmPrTWyTf/projects?limit=20&next=SOME_STRING_VALUE&slug=SOME_STRING_VALUE&teamId=SOME_STRING_VALUE", {
2  "headers": {
3    "Authorization": "Bearer <TOKEN>"
4  },
5  "method": "get"
6})

List access groups for a team, project or member

get/v1/access-groups

List access groups

Optional params

fetch-request

1await fetch("https://api.vercel.com/v1/access-groups?limit=20&membersLimit=20&next=SOME_STRING_VALUE&projectId=prj_pavWOn1iLObbx3RowVvzmPrTWyTf&projectsLimit=20&search=example&slug=SOME_STRING_VALUE&teamId=SOME_STRING_VALUE", {
2  "headers": {
3    "Authorization": "Bearer <TOKEN>"
4  },
5  "method": "get"
6})

Parameters

Query Params

Query Parameter	Description
limit	integer Limit how many access group should be returned. `>=1<=100` Example:`20`
membersLimit	integer Number of members to include in the response. `>=1<=100` Example:`20`
next	string Continuation cursor to retrieve the next page of results.
projectId	string Filter access groups by project. Example:`prj_pavWOn1iLObbx3RowVvzmPrTWyTf`
projectsLimit	integer Number of projects to include in the response. `>=1<=100` Example:`20`
search	string Search for access groups by name. Example:`example`
slug	string The Team slug to perform the request on behalf of.
teamId	string The Team identifier to perform the request on behalf of.

Response

One of the following objects
One of

Response Codes

Code	Description
`200`
`400`	One of the provided values in the request query is invalid.
`401`
`403`	You do not have permission to access this resource.
`404`

Optional params

fetch-request

1await fetch("https://api.vercel.com/v1/access-groups?limit=20&membersLimit=20&next=SOME_STRING_VALUE&projectId=prj_pavWOn1iLObbx3RowVvzmPrTWyTf&projectsLimit=20&search=example&slug=SOME_STRING_VALUE&teamId=SOME_STRING_VALUE", {
2  "headers": {
3    "Authorization": "Bearer <TOKEN>"
4  },
5  "method": "get"
6})

Reads an access group

get/v1/access-groups/{idOrName}

Allows to read an access group

Optional params

fetch-request

1await fetch("https://api.vercel.com/v1/access-groups/SOME_STRING_VALUE?slug=SOME_STRING_VALUE&teamId=SOME_STRING_VALUE", {
2  "headers": {
3    "Authorization": "Bearer <TOKEN>"
4  },
5  "method": "get"
6})

Parameters

Path Params

Query Params

Path Parameter	Description
idOrName	string required

Response

accessGroupIdstringRequired
ID of the access group.
Example: ag_123a6c5209bc3778245d011443644c8d27dc2c50

createdAtstringRequired
Timestamp in milliseconds when the access group was created.
Example: 1588720733602

entitlementsarray

isDsyncManagedbooleanRequired

membersCountnumberRequired
Number of members in the access group.
Example: 5

namestringRequired
The name of this access group.
Example: my-access-group

projectsCountnumberRequired
Number of projects in the access group.
Example: 2

teamIdstringRequired
ID of the team that this access group belongs to.
Example: team_123a6c5209bc3778245d011443644c8d27dc2c50

updatedAtstringRequired
Timestamp in milliseconds when the access group was last updated.
Example: 1588720733602

Response Codes

Code	Description
`200`
`400`	One of the provided values in the request query is invalid.
`401`
`403`	You do not have permission to access this resource.
`404`

Optional params

fetch-request

1await fetch("https://api.vercel.com/v1/access-groups/SOME_STRING_VALUE?slug=SOME_STRING_VALUE&teamId=SOME_STRING_VALUE", {
2  "headers": {
3    "Authorization": "Bearer <TOKEN>"
4  },
5  "method": "get"
6})

Reads an access group project

get/v1/access-groups/{accessGroupIdOrName}/projects/{projectId}

Allows reading an access group project

Optional params

fetch-request

1await fetch("https://api.vercel.com/v1/access-groups/SOME_STRING_VALUE/projects/SOME_STRING_VALUE?slug=SOME_STRING_VALUE&teamId=SOME_STRING_VALUE", {
2  "headers": {
3    "Authorization": "Bearer <TOKEN>"
4  },
5  "method": "get"
6})

Parameters

Path Params

Query Params

Path Parameter	Description
accessGroupIdOrName	string required
projectId	string required

Response

accessGroupIdstringRequired

createdAtstringRequired

projectIdstringRequired

rolestringRequired
One of: ADMIN | PROJECT_DEVELOPER | PROJECT_VIEWER

teamIdstringRequired

updatedAtstringRequired

Response Codes

Code	Description
`200`
`400`	One of the provided values in the request query is invalid.
`401`
`403`	You do not have permission to access this resource.
`404`

Optional params

fetch-request

1await fetch("https://api.vercel.com/v1/access-groups/SOME_STRING_VALUE/projects/SOME_STRING_VALUE?slug=SOME_STRING_VALUE&teamId=SOME_STRING_VALUE", {
2  "headers": {
3    "Authorization": "Bearer <TOKEN>"
4  },
5  "method": "get"
6})

Update an access group

post/v1/access-groups/{idOrName}

Allows to update an access group metadata

Optional params

fetch-request

1await fetch("https://api.vercel.com/v1/access-groups/SOME_STRING_VALUE?slug=SOME_STRING_VALUE&teamId=SOME_STRING_VALUE", {
2  "body": {
3    "membersToAdd": "SOME_ARRAY OF STRING_VALUE",
4    "membersToRemove": "SOME_ARRAY OF STRING_VALUE",
5    "name": "My access group",
6    "projects": [
7      {
8        "projectId": "prj_ndlgr43fadlPyCtREAqxxdyFK",
9        "role": "ADMIN"
10      }
11    ]
12  },
13  "headers": {
14    "Authorization": "Bearer <TOKEN>"
15  },
16  "method": "post"
17})

Parameters

Path Params

Query Params

Body Params

Path Parameter	Description
idOrName	string required

Response

accessGroupIdstringRequired
ID of the access group.
Example: ag_123a6c5209bc3778245d011443644c8d27dc2c50

createdAtstringRequired
Timestamp in milliseconds when the access group was created.
Example: 1588720733602

entitlementsarray

membersCountnumberRequired
Number of members in the access group.
Example: 5

namestringRequired
The name of this access group.
Example: my-access-group

projectsCountnumberRequired
Number of projects in the access group.
Example: 2

teamIdstringRequired
ID of the team that this access group belongs to.
Example: team_123a6c5209bc3778245d011443644c8d27dc2c50

updatedAtstringRequired
Timestamp in milliseconds when the access group was last updated.
Example: 1588720733602

Response Codes

Code	Description
`200`
`400`	One of the provided values in the request body is invalid. One of the provided values in the request query is invalid.
`401`
`403`	You do not have permission to access this resource.
`404`

Optional params

fetch-request

1await fetch("https://api.vercel.com/v1/access-groups/SOME_STRING_VALUE?slug=SOME_STRING_VALUE&teamId=SOME_STRING_VALUE", {
2  "body": {
3    "membersToAdd": "SOME_ARRAY OF STRING_VALUE",
4    "membersToRemove": "SOME_ARRAY OF STRING_VALUE",
5    "name": "My access group",
6    "projects": [
7      {
8        "projectId": "prj_ndlgr43fadlPyCtREAqxxdyFK",
9        "role": "ADMIN"
10      }
11    ]
12  },
13  "headers": {
14    "Authorization": "Bearer <TOKEN>"
15  },
16  "method": "post"
17})

Update an access group project

patch/v1/access-groups/{accessGroupIdOrName}/projects/{projectId}

Allows update of an access group project

Optional params

fetch-request

1await fetch("https://api.vercel.com/v1/access-groups/SOME_STRING_VALUE/projects/SOME_STRING_VALUE?slug=SOME_STRING_VALUE&teamId=SOME_STRING_VALUE", {
2  "body": {
3    "role": "ADMIN"
4  },
5  "headers": {
6    "Authorization": "Bearer <TOKEN>"
7  },
8  "method": "patch"
9})

Parameters

Path Params

Query Params

Body Params

Path Parameter	Description
accessGroupIdOrName	string required
projectId	string required

Response

accessGroupIdstringRequired

createdAtstringRequired

projectIdstringRequired

rolestringRequired
One of: ADMIN | PROJECT_DEVELOPER | PROJECT_VIEWER

teamIdstringRequired

updatedAtstringRequired

Response Codes

Code	Description
`200`
`400`	One of the provided values in the request body is invalid. One of the provided values in the request query is invalid.
`401`
`403`	You do not have permission to access this resource.
`404`

Optional params

fetch-request

1await fetch("https://api.vercel.com/v1/access-groups/SOME_STRING_VALUE/projects/SOME_STRING_VALUE?slug=SOME_STRING_VALUE&teamId=SOME_STRING_VALUE", {
2  "body": {
3    "role": "ADMIN"
4  },
5  "headers": {
6    "Authorization": "Bearer <TOKEN>"
7  },
8  "method": "patch"
9})

Last updated on November 23, 2024

Endpoints

Creates an access group

Was this helpful?