Method: projects.locations.workloadIdentityPools.list

Lists all non-deleted WorkloadIdentityPools in a project. If showDeleted is set to true, then deleted pools are also listed.

HTTP request

GET https://iam.googleapis.com/v1beta/{parent=projects/*/locations/*}/workloadIdentityPools

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
parent

string

Required. The parent resource to list pools for.

Query parameters

Parameters
pageSize

integer

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

pageToken

string

A page token, received from a previous workloadIdentityPools.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 workloadIdentityPools.list.

JSON representation
{
  "workloadIdentityPools": [
    {
      object (WorkloadIdentityPool)
    }
  ],
  "nextPageToken": string
}
Fields
workloadIdentityPools[]

object (WorkloadIdentityPool)

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.

IAM Permissions

Requires the following IAM permission on the parent resource:

  • iam.workloadIdentityPools.list

For more information, see the IAM documentation.