v0.0.1
OAS 3.0.3
Vercel SDK
The @vercel/sdk is a type-safe Typescript SDK that allows you to access the resources and methods of the Vercel REST API. Learn how to install it and authenticate with a Vercel access token.
access-groups
access-groups Endpoints
- POST/v1/access-groups/{accessGroupIdOrName}/projects
- POST/v1/access-groups
- DELETE/v1/access-groups/{accessGroupIdOrName}/projects/{projectId}
- DELETE/v1/access-groups/{idOrName}
- GET/v1/access-groups
- GET/v1/access-groups/{idOrName}/members
- GET/v1/access-groups/{idOrName}/projects
- GET/v1/access-groups/{idOrName}
- GET/v1/access-groups/{accessGroupIdOrName}/projects/{projectId}
- POST/v1/access-groups/{idOrName}
- PATCH/v1/access-groups/{accessGroupIdOrName}/projects/{projectId}
Create an access group project
Allows creation of an access group project
Path Parameters
- accessGroupIdOrNamestringrequired
Query Parameters
- teamIdstring
The Team identifier to perform the request on behalf of.
Exampleteam_1a2b3c4d5e6f7g8h9i0j1k2l - slugstring
The Team slug to perform the request on behalf of.
Examplemy-team-url-slug
Body
application/json
Hide Child Attributes
projectId
string max:
256 required
The ID of the project.
Example
prj_ndlgr43fadlPyCtREAqxxdyFKrole
string enum required
The project role that will be added to this Access Group.
Example
ADMIN- ADMIN
- PROJECT_VIEWER
- PROJECT_DEVELOPER
Responses
- 403
You do not have permission to access this resource.
POST/v1/access-groups/{accessGroupIdOrName}/projects
import { Vercel } from "@vercel/sdk";
const vercel = new Vercel({
bearerToken: "<YOUR_BEARER_TOKEN_HERE>",
});
async function run() {
const result = await vercel.accessGroups.createAccessGroupProject({
accessGroupIdOrName: "<value>",
teamId: "team_1a2b3c4d5e6f7g8h9i0j1k2l",
slug: "my-team-url-slug",
requestBody: {
projectId: "prj_ndlgr43fadlPyCtREAqxxdyFK",
role: "ADMIN",
},
});
// Handle the result
console.log(result);
}
run();
{
"teamId": "…",
"accessGroupId": "…",
"projectId": "…",
"role": "ADMIN",
"createdAt": "…",
"updatedAt": "…"
}