- HTTP request
- Path parameters
- Query parameters
- Request body
- Response body
- Authorization scopes
- IAM Permissions
- Examples
- Try it!
Lists all non-deleted WorkloadIdentityPool
s in a project. If showDeleted
is set to true
, then deleted pools are also listed.
HTTP request
GET https://iam.googleapis.com/v1/{parent=projects/*/locations/*}/workloadIdentityPools
The URL uses gRPC Transcoding syntax.
Path parameters
| Parameters | |
|---|---|
parent
|
Required. The parent resource to list pools for. |
Query parameters
| Parameters | |
|---|---|
pageSize
|
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
|
A page token, received from a previous |
showDeleted
|
Whether to return soft-deleted pools. |
Request body
The request body must be empty.
Response body
Response message for workloadIdentityPools.list.
If successful, the response body contains data with the following structure:
| JSON representation |
|---|
{
"workloadIdentityPools"
:
[
{
object (
|
| Fields | |
|---|---|
workloadIdentityPools[]
|
A list of pools. |
nextPageToken
|
A token, which can be sent as |
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 .

