Skip to content
Docs

Creates an access group

POSThttps://api.vercel.com/v1/access-groups
Allows to create an access group
Request
import { Vercel } from "@vercel/sdk";


const vercel = new Vercel({
  bearerToken: "<YOUR_BEARER_TOKEN_HERE>",
});


async function run() {
  const result = await vercel.accessGroups.createAccessGroup({
    teamId: "team_1a2b3c4d5e6f7g8h9i0j1k2l",
    slug: "my-team-url-slug",
    requestBody: {
      name: "My access group",
      projects: [
        {
          projectId: "prj_ndlgr43fadlPyCtREAqxxdyFK",
          role: "ADMIN",
        },
        {
          projectId: "prj_ndlgr43fadlPyCtREAqxxdyFK",
          role: "ADMIN",
        },
        {
          projectId: "prj_ndlgr43fadlPyCtREAqxxdyFK",
          role: "ADMIN",
        },
      ],
      membersToAdd: [
        "usr_1a2b3c4d5e6f7g8h9i0j",
        "usr_2b3c4d5e6f7g8h9i0j1k",
      ],
    },
  });


  console.log(result);
}


run();
Response
{
  "entitlements": [],
  "membersCount": "123",
  "projectsCount": "123",
  "name": "my-access-group",
  "createdAt": "1588720733602",
  "teamId": "team_123a6c5209bc3778245d011443644c8d27dc2c50",
  "updatedAt": "1588720733602",
  "accessGroupId": "ag_123a6c5209bc3778245d011443644c8d27dc2c50",
  "teamRoles": [],
  "teamPermissions": []
}

Authentication

AuthorizationbearerToken

Default authentication mechanism

Query parameters

teamIdstringOptional
The Team identifier to perform the request on behalf of.
slugstringOptional
The Team slug to perform the request on behalf of.

Body

application/json
namestringRequired
The name of the access group
projectsarrayOptional
membersToAddarrayOptional
List of members to add to the access group.

Response

200Success
entitlementsarrayRequired
membersCountnumberRequired
projectsCountnumberRequired
namestringRequired
The name of this access group.
createdAtstringRequired
Timestamp in milliseconds when the access group was created.
teamIdstringRequired
ID of the team that this access group belongs to.
updatedAtstringRequired
Timestamp in milliseconds when the access group was last updated.
accessGroupIdstringRequired
ID of the access group.
teamRolesarrayOptional
Roles that the team has in the access group.
teamPermissionsarrayOptional
Permissions that the team has in the access group.

Errors

400One of the provided values in the request body is invalid.
401The request is not authorized.
403You do not have permission to access this resource.
410Error