Method: projects.relatedaccountgroups.list

List groups of related accounts.

HTTP request

GET https://recaptchaenterprise.googleapis.com/v1/{parent=projects/*}/relatedaccountgroups

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
parent

string

Required. The name of the project to list related account groups from, in the format projects/{project}.

Query parameters

Parameters
pageSize

integer

Optional. The maximum number of groups to return. The service might return fewer than this value. If unspecified, at most 50 groups are returned. The maximum value is 1000; values above 1000 are coerced to 1000.
pageToken

string

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

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

Request body

The request body must be empty.

Response body

The response to a relatedaccountgroups.list call.

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

JSON representation 
{
  "relatedAccountGroups": [
    {
      object (RelatedAccountGroup)
    }
  ],
  "nextPageToken": string
}
Fields
relatedAccountGroups[]

object (RelatedAccountGroup)

The groups of related accounts listed by the query.
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:

  • recaptchaenterprise.relatedaccountgroups.list

For more information, see the IAM documentation.

RelatedAccountGroup

A group of related accounts.

JSON representation 
{
  "name": string
}
Fields
name

string

Required. Identifier. The resource name for the related account group in the format projects/{project}/relatedaccountgroups/{related_account_group}.