ListMemberships

client.groups.memberships.list(, ?): MembersPage<GroupMembership { id, avatarUrl, groupId, 2 more } >

POST/gitpod.v1.GroupService/ListMemberships

Lists all memberships of a group.

Use this method to:

View all members of a group
Audit group membership

Examples

List group members:

Shows all members of a specific group.

groupId: "d2c94c27-3b76-4a42-b88c-95a85e392c68"
pagination:
  pageSize: 20

Authorization

All organization members can view group membership (transparency model).

ParametersExpand Collapse

params: MembershipListParams { token, pageSize, filter, 2 more }

token?: string

Query param

pageSize?: number

Query param

maximum100

minimum0

filter?: Filter

Body param: filter contains options for filtering the list of memberships.

search?: string

search performs case-insensitive search across member name, email, ID, and service account name and description

maxLength256

groupId?: string

Body param

formatuuid

pagination?: Pagination

Body param: pagination contains the pagination options for listing memberships

token?: string

Token for the next set of results that was returned as next_token of a PaginationResponse

pageSize?: number

Page size is the maximum number of results to retrieve per page. Defaults to 25. Maximum 100.

formatint32

maximum100

ReturnsExpand Collapse

GroupMembership { id, avatarUrl, groupId, 2 more }

GroupMembership represents a subject’s membership in a group

id?: string

Unique identifier for the group membership

formatuuid

avatarUrl?: string

Subject’s avatar URL

groupId?: string

Group identifier

formatuuid

name?: string

Subject’s display name

subject?: Subject { id, principal }

Subject (user, runner, environment, service account, etc.)

id?: string

id is the UUID of the subject

formatuuid

principal?: Principal

Principal is the principal of the subject

One of the following:

"PRINCIPAL_UNSPECIFIED"

"PRINCIPAL_ACCOUNT"

"PRINCIPAL_USER"

"PRINCIPAL_RUNNER"

"PRINCIPAL_ENVIRONMENT"

"PRINCIPAL_SERVICE_ACCOUNT"

"PRINCIPAL_RUNNER_MANAGER"

ListMemberships

import Gitpod from '@gitpod/sdk';

const client = new Gitpod({
  bearerToken: process.env['GITPOD_API_KEY'], // This is the default and can be omitted
});

// Automatically fetches more pages as needed.
for await (const groupMembership of client.groups.memberships.list({
  groupId: 'd2c94c27-3b76-4a42-b88c-95a85e392c68',
  pagination: { pageSize: 20 },
})) {
  console.log(groupMembership.id);
}

{
  "members": [
    {
      "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
      "avatarUrl": "avatarUrl",
      "groupId": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
      "name": "name",
      "subject": {
        "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
        "principal": "PRINCIPAL_UNSPECIFIED"
      }
    }
  ],
  "pagination": {
    "nextToken": "nextToken"
  }
}

Returns Examples

{
  "members": [
    {
      "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
      "avatarUrl": "avatarUrl",
      "groupId": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
      "name": "name",
      "subject": {
        "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
        "principal": "PRINCIPAL_UNSPECIFIED"
      }
    }
  ],
  "pagination": {
    "nextToken": "nextToken"
  }
}