Contact UsGet started
© 2024 Direct Cursus Technology L.L.C.

Cloud Organization API, REST: Group.List

Written by
Updated at November 26, 2024

Retrieves the list of group resources.

HTTP request

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

Query parameters

Field

Description

organizationId

string

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

pageSize

string (int64)

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

pageToken

string

Page token. Set pageToken
to the ListGroupsResponse.nextPageToken
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].

Response

HTTP Code: 200 - OK

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

Field

Description

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.pageSize, use
the nextPageToken as the value
for the ListGroupsRequest.pageToken query parameter
in the next list request. Each subsequent list request will have its own
nextPageToken to continue paging through the results.

Group

A Group resource.
For more information, see Groups.

Field

Description

id

string

ID of the group.

organizationId

string

ID of the organization that the group belongs to.

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

name

string

Name of the group.

description

string

Description of the group.
Previous
Get
Next
Create