Method: groups.memberships.list

Lists the Memberships within a Group.

HTTP request

GET https://cloudidentity.googleapis.com/v1beta1/{parent=groups/*}/memberships

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
parent

string

Required. The parent Group resource under which to lookup the Membership name.

Must be of the form groups/{group_id}.

Query parameters

Parameters
view

enum (MembershipView)

The level of detail to be returned.

If unspecified, defaults to MembershipView.BASIC.

pageSize

integer

The maximum number of results to return.

Note that the number of results returned may be less than this value even if there are more available results. To fetch all results, clients must continue calling this method repeatedly until the response no longer contains a next_page_token.

If unspecified, defaults to 200 for GroupView.BASIC and to 50 for GroupView.FULL.

Must not be greater than 1000 for GroupView.BASIC or 500 for GroupView.FULL.

pageToken

string

The next_page_token value returned from a previous search request, if any.

Request body

The request body must be empty.

Response body

The response message for MembershipsService.ListMemberships.

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

JSON representation
{
  "memberships": [
    {
      object (Membership)
    }
  ],
  "nextPageToken": string
}
Fields
memberships[]

object (Membership)

The Memberships under the specified parent.

nextPageToken

string

A continuation token to retrieve the next page of results, or empty if there are no more results available.

Authorization scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/cloud-identity.groups.readonly
  • https://www.googleapis.com/auth/cloud-identity.groups
  • https://www.googleapis.com/auth/cloud-identity
  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

MembershipView

The view options for the MembershipsService.ListMemberships method.

Enums
BASICDefault. Only basic resource information is returned.
FULLAll resource information is returned.