Returns the caller's permissions on theWorkforcePool. If the pool doesn't exist, this call returns an empty set of permissions. It doesn't return aNOT_FOUNDerror.
HTTP request
POST https://iam.googleapis.com/v1/{resource=locations/*/workforcePools/*}:testIamPermissions
REQUIRED: The resource for which the policy detail is being requested. SeeResource namesfor the appropriate value for this field.
Request body
The request body contains data with the following structure:
JSON representation
{"permissions":[string]}
Fields
permissions[]
string
The set of permissions to check for theresource. Permissions with wildcards (such as*orstorage.*) are not allowed. For more information seeIAM Overview.
[[["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 endpoint tests the caller's permissions on a specified WorkforcePool resource, returning an empty set if the pool does not exist.\u003c/p\u003e\n"],["\u003cp\u003eThe HTTP request is a POST method to a URL that follows gRPC Transcoding syntax, requiring a \u003ccode\u003eresource\u003c/code\u003e path parameter indicating the target WorkforcePool.\u003c/p\u003e\n"],["\u003cp\u003eThe request body should contain a JSON object with a \u003ccode\u003epermissions\u003c/code\u003e array to check the caller's permissions against the specified resource.\u003c/p\u003e\n"],["\u003cp\u003eA successful request will result in a response body containing an instance of \u003ccode\u003eTestIamPermissionsResponse\u003c/code\u003e, and a permissions test can not contain wildcards.\u003c/p\u003e\n"],["\u003cp\u003eAuthorization for this endpoint requires one of the specified OAuth scopes: \u003ccode\u003ehttps://www.googleapis.com/auth/cloud-platform\u003c/code\u003e or \u003ccode\u003ehttps://www.googleapis.com/auth/iam\u003c/code\u003e.\u003c/p\u003e\n"]]],[],null,["# Method: locations.workforcePools.testIamPermissions\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Path parameters](#body.PATH_PARAMETERS)\n- [Request body](#body.request_body)\n - [JSON representation](#body.request_body.SCHEMA_REPRESENTATION)\n- [Response body](#body.response_body)\n- [Authorization scopes](#body.aspect)\n- [Examples](#examples)\n- [Try it!](#try-it)\n\nReturns the caller's permissions on the [WorkforcePool](/iam/docs/reference/rest/v1/locations.workforcePools#WorkforcePool). If the pool doesn't exist, this call returns an empty set of permissions. It doesn't return a `NOT_FOUND` error.\n\n### HTTP request\n\n`POST https://iam.googleapis.com/v1/{resource=locations/*/workforcePools/*}:testIamPermissions`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n### Request body\n\nThe request body contains data with the following structure:\n\n### Response body\n\nIf successful, the response body contains an instance of [TestIamPermissionsResponse](/iam/docs/reference/rest/v1/TestIamPermissionsResponse).\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)."]]
