Method 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 100. |
| filter | A filter expression that filters resources listed in the response. The expression must specify:
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. |
| 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. |