ListMembers

List group active members.

TypeScript

import { cloudApi, serviceClients, Session } from "@yandex-cloud/nodejs-sdk";

const ListGroupMembersRequest =
  cloudApi.organizationmanager.group_service.ListGroupMembersRequest;

(async () => {
  const authToken = process.env["YC_OAUTH_TOKEN"];
  const session = new Session({ oauthToken: authToken });
  const client = session.client(serviceClients.GroupServiceClient);

  const result = await client.listMembers(
    ListGroupMembersRequest.fromPartial({
      groupId: "groupId",
      // pageSize: 0,
      // pageToken: "pageToken"
    })
  );
  console.log(result);
})();

Python

import os
import grpc
import yandexcloud

from yandex.cloud.organizationmanager.v1.group_service_pb2_grpc import GroupServiceStub
from yandex.cloud.organizationmanager.v1.group_service_pb2 import ListGroupMembersRequest

token = os.getenv("YC_OAUTH_TOKEN")

sdk = yandexcloud.SDK(token=token)

service = sdk.client(GroupServiceStub)
response = service.ListMembers(
    ListGroupMembersRequest(
        group_id="groupId",
        # page_size = 0,
        # page_token = "pageToken"
    )
)
print(response)

ListGroupMembersRequest

groupId : string

ID of the Group resource to list members for.

pageSize : int64

The maximum number of results per page to return. If the number of available results is larger than page_size, the service returns a ListGroupMembersResponse.next_page_token that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 1000, inclusive. Default value: 100.

pageToken : string

Page token. Set page_token to the ListGroupMembersResponse.next_page_token returned by a previous list request to get the next page of results.

ListGroupMembersResponse

members : GroupMember

List of members for the specified group.

nextPageToken : string

This token allows you to get the next page of results for list requests. If the number of results is larger than ListGroupMembersRequest.page_size, use the next_page_token as the value for the ListGroupMembersRequest.page_token query parameter in the next list request. Each subsequent list request will have its own next_page_token to continue paging through the results.

GroupMember

subjectId : string

ID of the subject.

subjectType : string

Type of the subject.

It can contain one of the following values:

• userAccount: An account on Yandex, added to Yandex Cloud.
• federatedUser: A federated account. This type represents a user from an identity federation, like Active Directory.

---