Method: projects.locations.apis.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

POST https://apigateway.googleapis.com/v1beta/{resource=projects/*/locations/*/apis/*}:testIamPermissions

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
resource

string

REQUIRED: The resource for which the policy detail is being requested. See the operation documentation 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 the following OAuth scope:

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

For more information, see the Authentication Overview.