Method: projects.locations.scopes.listMemberships

Lists Memberships bound to a Scope. The response includes relevant Memberships from all regions.

HTTP request

GET https://gkehub.googleapis.com/v1alpha/{scopeName=projects/*/locations/*/scopes/*}:listMemberships

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
scopeName

string

Required. Name of the Scope, in the format projects/*/locations/global/scopes/*, to which the Memberships are bound.

Authorization requires the following IAM permission on the specified resource scopeName:

  • gkehub.scopes.listBoundMemberships

Query parameters

Parameters
filter

string

Optional. Lists Memberships that match the filter expression, following the syntax outlined in https://google.aip.dev/160. Currently, filtering can be done only based on Memberships's name, labels, createTime, updateTime, and uniqueId.
pageSize

integer

Optional. When requesting a 'page' of resources, pageSize specifies number of resources to return. If unspecified or set to 0, all resources will be returned. Pagination is currently not supported; therefore, setting this field does not have any impact for now.
pageToken

string

Optional. Token returned by previous call to scopes.listMemberships which specifies the position in the list from where to continue listing the resources.

Request body

The request body must be empty.

Response body

List of Memberships bound to a Scope.

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

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

object (Membership)

The list of Memberships bound to the given Scope.
unreachable[]

string

List of locations that could not be reached while fetching this list.
nextPageToken

string

A token to request the next page of resources from the scopes.listMemberships method. The value of an empty string means that there are no more resources to return.

Authorization scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview.