access-groups

Reads an access group

Changed on

Allows to read an access group

get/v1/access-groups/{idOrName}

Request

  • Base URL: https://api.vercel.com
  • URL: https://api.vercel.com/v1/access-groups/{idOrName}
  • Auth: HTTP bearer

Path parameters

idOrNamestring required

Query parameters

teamIdstring
Example:team_1a2b3c4d5e6f7g8h9i0j1k2l

The Team identifier to perform the request on behalf of.

slugstring
Example:my-team-url-slug

The Team slug to perform the request on behalf of.

Response

accessGroupIdstring required

ID of the access group.

createdAtstring required

Timestamp in milliseconds when the access group was created.

entitlementsstring[]
isDsyncManagedfalse | true required
membersCountnumber required

Number of members in the access group.

namestring required

The name of this access group.

projectsCountnumber required

Number of projects in the access group.

teamIdstring required

ID of the team that this access group belongs to.

teamPermissionsstring[]
teamRolesstring[]

Roles that the team has in the access group.

updatedAtstring required

Timestamp in milliseconds when the access group was last updated.

Example response

{
  "accessGroupId": "ag_123a6c5209bc3778245d011443644c8d27dc2c50",
  "membersCount": 5,
  "name": "my-access-group",
  "projectsCount": 2,
  "teamId": "team_123a6c5209bc3778245d011443644c8d27dc2c50",
  "teamRoles": [
    "DEVELOPER",
    "BILLING"
  ]
}

Changes

  • 099fbe1f521cRevision changes
    • info

      added the non-success response with the status

  • 10dff3be52ffRevision changes
    • warning

      added the new AiGatewayUser enum value to the / response property for the response status

    • info

      removed the AiGatewayApiKeyOwnedBySelf enum value from the / response property for the response status