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
Field |
Description |
organizationId |
string Required field. ID of the organization to list groups in. |
pageSize |
string (int64) The maximum number of results per page to return. If the number of available |
pageToken |
string Page token. Set |
filter |
string A filter expression that filters resources listed in the response.
|
Response
HTTP Code: 200 - OK
{
"groups": [
{
"id": "string",
"organizationId": "string",
"createdAt": "string",
"name": "string",
"description": "string"
}
],
"nextPageToken": "string"
}
Field |
Description |
groups[] |
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 |
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 To work with values in this field, use the APIs described in the |
name |
string Name of the group. |
description |
string Description of the group. |