Method: locations.workforcePools.testIamPermissions

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_FOUND error.

HTTP request

POST https://iam.googleapis.com/v1/{resource=locations/*/workforcePools/*}:testIamPermissions

The URL usesgRPC Transcoding syntax.

Path parameters

Parameters
resource

string

REQUIRED: The resource for which the policy detail is being requested. SeeResource names for 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.

Response body

If successful, the response body contains an instance ofTestIamPermissionsResponse.

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 theAuthentication Overview.

Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2025-05-21 UTC.