Buckets: testIamPermissions

Tests a set of permissions on the given bucket to see which, if any, are held by the caller.

Required permissions

Permissions are not required for using this method.


HTTP request

GET https://storage.googleapis.com/storage/v1/b/bucket/iam/testPermissions

In addition to standard query parameters, the following query parameters apply to this method.

To see an example of how to include query parameters in a request, see the JSON API Overview page.


Parameter name Value Description
Path parameters
bucket string Name of a bucket.
Required query parameters
permissions string Permissions to test.

Note: Providing storage.buckets.list or storage.buckets.create returns an error, as these permissions apply to projects instead of buckets.

Request body

Do not supply a request body with this method.


If successful, this method returns a response body with the following structure:

  "kind": "storage#testIamPermissionsResponse",
  "permissions": [
Property name Value Description Notes
kind string The kind of item this is.
permissions[] list The permissions held by the caller. Permissions are always of the format "storage.resource.capability", where resource is one of buckets, objects, or managedFolders. See Cloud Storage IAM Permissions for a list of supported permissions.

For information about status and error codes returned by this API, see the reference page.

Try it!

Use the APIs Explorer below to call this method on live data and see the response.