Method: keyRings.testIamPermissions

• HTTP request
• Path parameters
• Request body
  • JSON representation
• Response body
• Authorization scopes
• Try it!

Full name: projects.locations.keyRings.testIamPermissions

Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error.

Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.

HTTP request

Choose a location:

global europe-west3 europe-west8 europe-west9 me-central2 us-east1 us-east4 us-west2 us-west1 us-east7 us-central1 us-west3 us-central2 us-west4 us-west8 us-east5 us-south1

The URLs use gRPC Transcoding syntax.

Path parameters

Parameters
resource	string REQUIRED: The resource for which the policy detail is being requested. See Resource 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 the resource. Permissions with wildcards (such as * or storage.*) are not allowed. For more information see IAM Overview.

Response body

If successful, the response body contains an instance of TestIamPermissionsResponse.

Authorization scopes

Requires one of the following OAuth scopes:

• https://www.googleapis.com/auth/cloudkms
• https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.