Method: federationGroups.list

Full name: projects.locations.instances.federationGroups.list

federationGroups.list method lists all Federation groups.

HTTP request


Path parameters

Parameters
parent

string

Required. The parent, which owns this collection of Federation Groups. Format: projects/{project}/locations/{location}/instances/{instance}

Query parameters

Parameters
pageSize

integer

Optional. The maximum number of Federation Groups to return. The service may return fewer than this value. If unspecified, at most 100 Federation Groups will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
pageToken

string

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

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

Request body

The request body must be empty.

Response body

Response message for federationGroups.list RPC.

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

JSON representation 
{
  "federationGroups": [
    {
      object (FederationGroup)
    }
  ],
  "nextPageToken": string
}
Fields
federationGroups[]

object (FederationGroup)

The Federation Groups from the specified Instance.
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 the following OAuth scope:

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

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the parent resource:

  • chronicle.federationGroups.list

For more information, see the IAM documentation.