Method: services.groups.members.list

List members for the given service group. The service group is a producer defined service group.

HTTP request

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

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
parent

string

Required. The parent group state that exposes the members.

Query parameters

Parameters
pageSize

integer

The maximum number of members to return. The service may return fewer than this value. If unspecified, at most 50 members 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 members.list call. Provide this to retrieve the subsequent page.

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

enum (MemberStateView)

The view of the member state to use.

Request body

The request body must be empty.

Response body

The response message of the members.list method.

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

JSON representation 
{
  "memberStates": [
    {
      object (MemberState)
    }
  ],
  "nextPageToken": string
}
Fields
memberStates[]

object (MemberState)

The member states exposed by the parent group.
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.

MemberStateView

The view of the member state.

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

MemberState

Information about the member state with respect to a particular consumer.

JSON representation 
{
  "name": string,
  "member": {
    object (Member)
  }
}
Fields
name

string

Output only. The resource name of the member state.
member

object (Member)

Output only. The member referenced by this state.

Member

A service group member that belongs to a certain service group. It can be a service group or a single service.

JSON representation 
{
  "parent": string,

  // Union field name can be only one of the following:
  "serviceName": string,
  "groupName": string
  // End of list of possible types for union field name.
  "reason": string
}
Fields
parent

string

The parent group to which this member belongs.
Union field name. The name of a service group member, which can be another service or another group of services. name can be only one of the following:
serviceName

string
groupName

string
reason

string

Information on why the member is a part of this group. Provided by the service owner.