Подключиться
Yandex Cloud Organization

Cloud Organization API, REST: Group.list

Статья создана

Retrieves the list of group resources.

HTTP request

GET https://organization-manager.api.cloud.yandex.net/organization-manager/v1/groups

Query parameters

Parameter Description
organizationId

Required. ID of the organization to list groups in. To get the organization ID, use a list request.

The maximum string length in characters is 50.
pageSize

The maximum number of results per page to return. If the number of available results is larger than pageSize, the service returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Default value: 100.

Acceptable values are 0 to 1000, inclusive.
pageToken

Page token. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.

The maximum string length in characters is 2000.
filter

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].

The maximum string length in characters is 1000.

Response

HTTP Code: 200 - OK

{
  "groups": [
    {
      "id": "string",
      "organizationId": "string",
      "createdAt": "string",
      "name": "string",
      "description": "string"
    }
  ],
  "nextPageToken": "string"
}
Field Description
groups[] object

List of Group resources.
groups[].
id		 string

ID of the group.
groups[].
organizationId		 string

ID of the organization that the group belongs to.
groups[].
createdAt		 string (date-time)

Creation timestamp.

String in RFC3339 text format. The range of possible values is from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z, i.e. from 0 to 9 digits for fractions of a second.

To work with values in this field, use the APIs described in the Protocol Buffers reference. In some languages, built-in datetime utilities do not support nanosecond precision (9 digits).
groups[].
name		 string

Name of the group.
groups[].
description		 string

Description of the 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 pageSize, use the nextPageToken as the value for the pageToken query parameter in the next list request. Each subsequent list request will have its own nextPageToken to continue paging through the results.
В этой статье: