Method: locations.workforcePools.list

Lists all non-deleted WorkforcePool s 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. The default value is 50. The maximum value is 100.

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

Response message for workforcePools.list.

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

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 .

Create a Mobile Website
View Site in Mobile | Classic
Share by: