Method: services.groups.list

HTTP request
Path parameters
Query parameters
Request body
Response body
- JSON representation
Authorization scopes
GroupStateView
GroupState
- JSON representation
Group
- JSON representation

List service groups owned by the given service.

HTTP request

GET https://serviceusage.googleapis.com/v2beta/{parent=*/*/services/*}/groups

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters

Parameters
`parent`	`string` Required. The parent service state that exposes the group states.

parent

string

Required. The parent service state that exposes the group states.

Query parameters

Parameters

Parameters
`pageSize`	`integer` The maximum number of groups to return. The service may return fewer than this value. If unspecified, at most 50 groups will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
`pageToken`	`string` A page token, received from a previous `groups.list` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `groups.list` must match the call that provided the page token.
`view`	`enum ( GroupStateView )` The view of the group state to use.

pageSize

integer

The maximum number of groups to return. The service may return fewer than this value. If unspecified, at most 50 groups will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.

pageToken

string

A page token, received from a previous groups.list call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to groups.list must match the call that provided the page token.

view

enum ( GroupStateView )

The view of the group state to use.

Request body

The request body must be empty.

Response body

The response message of the groups.list method.

If successful, the response body contains data with the following structure:

JSON representation
{ "groups" : [ { object ( `GroupState` ) } ] , "nextPageToken" : string }

Fields

Fields
`groups[]`	`object ( GroupState )` The group states exposed by the parent service.
`nextPageToken`	`string` A token, which can be sent as `pageToken` to retrieve the next page. If this field is omitted, there are no subsequent pages.

groups[]

object ( GroupState )

The group states exposed by the parent service.

nextPageToken

string

A token, which can be sent as pageToken to retrieve the next page. If this field is omitted, there are no subsequent pages.

Authorization scopes

Requires one of the following OAuth scopes:

https://www.googleapis.com/auth/cloud-platform.read-only
https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview .

GroupStateView

The view of the group state.

Enums
`GROUP_STATE_VIEW_UNSPECIFIED`	The default / unset value. The API will default to the BASIC view.
`GROUP_STATE_VIEW_BASIC`	The basic view includes only the group metadata, it does not include information about the current state of the group. This is the default value.
`GROUP_STATE_VIEW_FULL`	Include everything.

GroupState

Information about the state of a group with respect to a consumer resource.

JSON representation
{ "name" : string , "group" : { object ( `Group` ) } }

Fields

Fields
`name`	`string` Output only. The resource name of the group state.
`group`	`object ( Group )` Output only. The group referenced by this state.

name

string

Output only. The resource name of the group state.

group

object ( Group )

Output only. The group referenced by this state.

Group

Information about the group.

JSON representation
{ "name" : string , "displayName" : string , "description" : string }

Fields

Fields
`name`	`string` The resource name of the group.
`displayName`	`string` The display name of the group.
`description`	`string` The detailed description of the group.

name

string

The resource name of the group.

displayName

string

The display name of the group.

description

string

The detailed description of the group.