Endpoints
- GETReads an access group
- POSTUpdate an access group
- DELDeletes an access group
- GETList members of an access group
- GETList access groups for a team, project or member
- POSTCreates an access group
- GETList projects of an access group
- POSTCreate an access group project
- GETReads an access group project
- DELDelete an access group project
- PATCHUpdate an access group project
- GET
readAccessGroup
import { Vercel } from "@vercel/sdk";const vercel = new Vercel({ bearerToken: "<YOUR_BEARER_TOKEN_HERE>",});async function run() { const result = await vercel.accessGroups.readAccessGroup({ idOrName: "ag_1a2b3c4d5e6f7g8h9i0j", teamId: "team_1a2b3c4d5e6f7g8h9i0j1k2l", slug: "my-team-url-slug", }); console.log(result);}run();{ "teamPermissions": [ "IntegrationManager" ], "entitlements": [ "v0" ], "isDsyncManaged": true, "name": "my-access-group", "createdAt": 1588720733602, "teamId": "team_123a6c5209bc3778245d011443644c8d27dc2c50", "updatedAt": 1588720733602, "accessGroupId": "ag_123a6c5209bc3778245d011443644c8d27dc2c50", "membersCount": 5, "projectsCount": 2, "teamRoles": [ "DEVELOPER", "BILLING" ]}access-groups
Reads an access group
Allows to read an access group
GET
/
v1
/
access-groups
/
{idOrName}
readAccessGroup
import { Vercel } from "@vercel/sdk";const vercel = new Vercel({ bearerToken: "<YOUR_BEARER_TOKEN_HERE>",});async function run() { const result = await vercel.accessGroups.readAccessGroup({ idOrName: "ag_1a2b3c4d5e6f7g8h9i0j", teamId: "team_1a2b3c4d5e6f7g8h9i0j1k2l", slug: "my-team-url-slug", }); console.log(result);}run();{ "teamPermissions": [ "IntegrationManager" ], "entitlements": [ "v0" ], "isDsyncManaged": true, "name": "my-access-group", "createdAt": 1588720733602, "teamId": "team_123a6c5209bc3778245d011443644c8d27dc2c50", "updatedAt": 1588720733602, "accessGroupId": "ag_123a6c5209bc3778245d011443644c8d27dc2c50", "membersCount": 5, "projectsCount": 2, "teamRoles": [ "DEVELOPER", "BILLING" ]}Authorizations
Default authentication mechanism
Path Parameters
Query Parameters
The Team identifier to perform the request on behalf of.
Example:
"team_1a2b3c4d5e6f7g8h9i0j1k2l"
The Team slug to perform the request on behalf of.
Example:
"my-team-url-slug"
Response
The name of this access group.
Example:
"my-access-group"
Timestamp in milliseconds when the access group was created.
Example:
1588720733602
ID of the team that this access group belongs to.
Example:
"team_123a6c5209bc3778245d011443644c8d27dc2c50"
Timestamp in milliseconds when the access group was last updated.
Example:
1588720733602
ID of the access group.
Example:
"ag_123a6c5209bc3778245d011443644c8d27dc2c50"
Number of members in the access group.
Example:
5
Number of projects in the access group.
Example:
2
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Roles that the team has in the access group.
Example:
["DEVELOPER","BILLING"]⌘I