List access groups for a team, project or member

GET

access-groups

Copy
import { Vercel } from "@vercel/sdk";

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

async function run() {
  const result = await vercel.accessGroups.listAccessGroups({
    projectId: "prj_pavWOn1iLObbx3RowVvzmPrTWyTf",
    search: "example",
    membersLimit: 20,
    projectsLimit: 20,
    limit: 20,
    teamId: "team_1a2b3c4d5e6f7g8h9i0j1k2l",
    slug: "my-team-url-slug",
  });

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

run();

{}

Authorizations

Authorization

string

header

required

Default authentication mechanism

Query Parameters

projectId

string

Filter access groups by project.

Example:

"prj_pavWOn1iLObbx3RowVvzmPrTWyTf"

string

Search for access groups by name.

Example:

"example"

membersLimit

integer

Number of members to include in the response.

Required range: 1 <= x <= 100

Example:

20

projectsLimit

integer

Number of projects to include in the response.

Required range: 1 <= x <= 100

Example:

20

limit

integer

Limit how many access group should be returned.

Required range: 1 <= x <= 100

Example:

20

string

Continuation cursor to retrieve the next page of results.

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"

Response

200

application/json

The response is of type object.

accessGroups

object[]

required

accessGroups.isDsyncManaged

boolean

required

accessGroups.name

string

required

The name of this access group.

Example:

"my-access-group"

accessGroups.createdAt

string

required

Timestamp in milliseconds when the access group was created.

Example:

1588720733602

accessGroups.teamId

string

required

ID of the team that this access group belongs to.

Example:

"team_123a6c5209bc3778245d011443644c8d27dc2c50"

accessGroups.updatedAt

string

required

Timestamp in milliseconds when the access group was last updated.

Example:

1588720733602

accessGroups.accessGroupId

string

required

ID of the access group.

Example:

"ag_123a6c5209bc3778245d011443644c8d27dc2c50"

accessGroups.membersCount

number

required

Number of members in the access group.

Example:

5

accessGroups.projectsCount

number

required

Number of projects in the access group.

Example:

2

accessGroups.members

string[]

accessGroups.projects

string[]

accessGroups.entitlements

string[]

accessGroups.teamRoles

string[]

Roles that the team has in the access group.

Example:

["DEVELOPER", "BILLING"]

accessGroups.teamPermissions

string[]

Permissions that the team has in the access group.

Example:

["CreateProject"]

pagination

object

required

List members of an access group Creates an access group

Copy
import { Vercel } from "@vercel/sdk";

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

async function run() {
  const result = await vercel.accessGroups.listAccessGroups({
    projectId: "prj_pavWOn1iLObbx3RowVvzmPrTWyTf",
    search: "example",
    membersLimit: 20,
    projectsLimit: 20,
    limit: 20,
    teamId: "team_1a2b3c4d5e6f7g8h9i0j1k2l",
    slug: "my-team-url-slug",
  });

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

run();

{}

Endpoints

Authorizations

Query Parameters

Response