Method: locations.workforcePools.list

Stay organized with collections Save and categorize content based on your preferences.

Lists all non-deleted WorkforcePools under the specified parent. If showDeleted is set to true, then deleted pools are also listed.

HTTP request

GET https://iam.googleapis.com/v1/{location=locations/*}/workforcePools

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
location

string

The location of the pool.

Format: locations/{location}.

Query parameters

Parameters
parent

string

Required. The parent resource to list pools for.

Format: organizations/{org-id}.

pageSize

integer

The maximum number of pools to return. If unspecified, at most 50 pools will be returned. The maximum value is 1000; values above 1000 are truncated to 1000.

pageToken

string

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

showDeleted

boolean

Whether to return soft-deleted pools.

Request body

The request body must be empty.

Response body

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

Response message for workforcePools.list.

JSON representation
{
  "workforcePools": [
    {
      object (WorkforcePool)
    }
  ],
  "nextPageToken": string
}
Fields
workforcePools[]

object (WorkforcePool)

A list of pools.

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
  • https://www.googleapis.com/auth/iam

For more information, see the Authentication Overview.