POST
/
v1
/
access-groups
/
{idOrName}
import { Vercel } from "@vercel/sdk";

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

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

  // Handle the result
  console.log(result);
}

run();
{
  "entitlements": [
    "v0"
  ],
  "name": "my-access-group",
  "createdAt": 1588720733602,
  "teamId": "team_123a6c5209bc3778245d011443644c8d27dc2c50",
  "updatedAt": 1588720733602,
  "accessGroupId": "ag_123a6c5209bc3778245d011443644c8d27dc2c50",
  "membersCount": 5,
  "projectsCount": 2,
  "teamRoles": [
    "DEVELOPER",
    "BILLING"
  ],
  "teamPermissions": [
    "CreateProject"
  ]
}

Authorizations

​
Authorization
string
header
required

Default authentication mechanism

Path Parameters

​
idOrName
string
required

Query Parameters

​
teamId
string

The Team identifier to perform the request on behalf of.

Example:

"team_1a2b3c4d5e6f7g8h9i0j1k2l"

​
slug
string

The Team slug to perform the request on behalf of.

Example:

"my-team-url-slug"

Body

application/json
​
name
string

The name of the access group

Maximum length: 50
Example:

"My access group"

​
projects
object[]
​
membersToAdd
string[]

List of members to add to the access group.

Example:
[
  "usr_1a2b3c4d5e6f7g8h9i0j",
  "usr_2b3c4d5e6f7g8h9i0j1k"
]
​
membersToRemove
string[]

List of members to remove from the access group.

Example:
[
  "usr_1a2b3c4d5e6f7g8h9i0j",
  "usr_2b3c4d5e6f7g8h9i0j1k"
]

Response

200
application/json
​
name
string
required

The name of this access group.

Example:

"my-access-group"

​
createdAt
string
required

Timestamp in milliseconds when the access group was created.

Example:

1588720733602

​
teamId
string
required

ID of the team that this access group belongs to.

Example:

"team_123a6c5209bc3778245d011443644c8d27dc2c50"

​
updatedAt
string
required

Timestamp in milliseconds when the access group was last updated.

Example:

1588720733602

​
accessGroupId
string
required

ID of the access group.

Example:

"ag_123a6c5209bc3778245d011443644c8d27dc2c50"

​
membersCount
number
required

Number of members in the access group.

Example:

5

​
projectsCount
number
required

Number of projects in the access group.

Example:

2

​
entitlements
enum<string>[]
Available options:
v0
​
teamRoles
string[]

Roles that the team has in the access group.

Example:
["DEVELOPER", "BILLING"]
​
teamPermissions
string[]

Permissions that the team has in the access group.

Example:
["CreateProject"]