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
Response message for workloadIdentityPools.list.
If successful, the response body contains data with the following structure:
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-05-21 UTC."],[[["\u003cp\u003eThis page details how to list all non-deleted WorkloadIdentityPools within a project, with the option to include deleted pools.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003eGET\u003c/code\u003e HTTP request to \u003ccode\u003ehttps://iam.googleapis.com/v1/{parent=projects/*/locations/*}/workloadIdentityPools\u003c/code\u003e is used to retrieve the list of pools, and it requires a \u003ccode\u003eparent\u003c/code\u003e path parameter specifying the project and location.\u003c/p\u003e\n"],["\u003cp\u003eThe query parameters \u003ccode\u003epageSize\u003c/code\u003e, \u003ccode\u003epageToken\u003c/code\u003e, and \u003ccode\u003eshowDeleted\u003c/code\u003e allow for controlling the number of pools returned, pagination, and inclusion of deleted pools, respectively.\u003c/p\u003e\n"],["\u003cp\u003eThe response body will contain an array of \u003ccode\u003eworkloadIdentityPools\u003c/code\u003e and a \u003ccode\u003enextPageToken\u003c/code\u003e if there are additional pages of results.\u003c/p\u003e\n"],["\u003cp\u003eListing WorkloadIdentityPools requires either the \u003ccode\u003ehttps://www.googleapis.com/auth/cloud-platform\u003c/code\u003e or \u003ccode\u003ehttps://www.googleapis.com/auth/iam\u003c/code\u003e OAuth scope, along with the \u003ccode\u003eiam.workloadIdentityPools.list\u003c/code\u003e IAM permission on the parent resource.\u003c/p\u003e\n"]]],[],null,["# Method: projects.locations.workloadIdentityPools.list\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Path parameters](#body.PATH_PARAMETERS)\n- [Query parameters](#body.QUERY_PARAMETERS)\n- [Request body](#body.request_body)\n- [Response body](#body.response_body)\n - [JSON representation](#body.ListWorkloadIdentityPoolsResponse.SCHEMA_REPRESENTATION)\n- [Authorization scopes](#body.aspect)\n- [IAM Permissions](#body.aspect_1)\n- [Examples](#examples)\n- [Try it!](#try-it)\n\nLists all non-deleted [WorkloadIdentityPool](/iam/docs/reference/rest/v1/projects.locations.workloadIdentityPools#WorkloadIdentityPool)s in a project. If `showDeleted` is set to `true`, then deleted pools are also listed.\n\n### HTTP request\n\n`GET https://iam.googleapis.com/v1/{parent=projects/*/locations/*}/workloadIdentityPools`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n### Query parameters\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\nResponse message for workloadIdentityPools.list.\n\nIf successful, the response body contains data with the following structure:\n\n### Authorization scopes\n\nRequires one of the following OAuth scopes:\n\n- `https://www.googleapis.com/auth/cloud-platform`\n- `\n https://www.googleapis.com/auth/iam`\n\nFor more information, see the [Authentication Overview](/docs/authentication#authorization-gcp).\n\n### IAM Permissions\n\nRequires the following [IAM](https://cloud.google.com/iam/docs) permission on the `parent` resource:\n\n- `iam.workloadIdentityPools.list`\n\nFor more information, see the [IAM documentation](https://cloud.google.com/iam/docs)."]]