List

Retrieves the list of group resources.

TypeScript

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

const ListGroupsRequest =
  cloudApi.organizationmanager.group_service.ListGroupsRequest;

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

  const result = await client.list(
    ListGroupsRequest.fromPartial({
      organizationId: "organizationId",
      // pageSize: 0,
      // pageToken: "pageToken",
      // filter: "filter"
    })
  );
  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 ListGroupsRequest

token = os.getenv("YC_OAUTH_TOKEN")

sdk = yandexcloud.SDK(token=token)

service = sdk.client(GroupServiceStub)
response = service.List(
    ListGroupsRequest(
        organization_id="organizationId",
        # page_size = 0,
        # page_token = "pageToken",
        # filter = "filter"
    )
)
print(response)

ListGroupsRequest

organizationId : string

ID of the organization to list groups in. To get the organization ID, use a yandex.cloud.organizationmanager.v1.OrganizationService.List request.

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 ListGroupsResponse.next_page_token that can be used to get the next page of results in subsequent list requests. Default value: 100.

pageToken : string

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

filter : string

A filter expression that filters resources listed in the response. The expression must specify:

1. The field name. Currently you can use filtering only on the Group.name field.
2. An = operator.
3. The value in double quotes ("). Must be 3-63 characters long and match the regular expression [a-z][-a-z0-9]{1,61}[a-z0-9].

ListGroupsResponse

groups : Group

List of Group resources.

nextPageToken : string

This token allows you to get the next page of results for list requests. If the number of results is larger than ListGroupsRequest.page_size, use the next_page_token as the value for the ListGroupsRequest.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.

Group

A Group resource. For more information, see Groups.

id : string

ID of the group.

organizationId : string

ID of the organization that the group belongs to.

createdAt : google.protobuf.Timestamp

Creation timestamp.

name : string

Name of the group.

description : string

Description of the group.

---