Method: iam.troubleshoot

Checks whether a member has a specific permission for a specific resource, and explains why the member does or does not have that permission.

HTTP request

POST https://policytroubleshooter.googleapis.com/v1/iam:troubleshoot

The URL uses gRPC Transcoding syntax.

Request body

The request body contains data with the following structure:

JSON representation
{
  "accessTuple": {
    object (AccessTuple)
  }
}
Fields
accessTuple

object (AccessTuple)

The information to use for checking whether a member has a permission for a resource.

Response body

If successful, the response body contains data with the following structure:

Response for iam.troubleshoot.

JSON representation
{
  "access": enum (AccessState),
  "explainedPolicies": [
    {
      object (ExplainedPolicy)
    }
  ]
}
Fields
access

enum (AccessState)

Indicates whether the member has the specified permission for the specified resource, based on evaluating all of the applicable IAM policies.

explainedPolicies[]

object (ExplainedPolicy)

List of IAM policies that were evaluated to check the member's permissions, with annotations to indicate how each policy contributed to the final result.

The list of policies can include the policy for the resource itself. It can also include policies that are inherited from higher levels of the resource hierarchy, including the organization, the folder, and the project.

To learn more about the resource hierarchy, see https://cloud.google.com/iam/help/resource-hierarchy.

Authorization Scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview.

AccessTuple

Information about the member, resource, and permission to check.

JSON representation
{
  "principal": string,
  "fullResourceName": string,
  "permission": string
}
Fields
principal

string

Required. The member, or principal, whose access you want to check, in the form of the email address that represents that member. For example, alice@example.com or my-service-account@my-project.iam.gserviceaccount.com.

The member must be a Google Account or a service account. Other types of members are not supported.

fullResourceName

string

Required. The full resource name that identifies the resource. For example, //compute.googleapis.com/projects/my-project/zones/us-central1-a/instances/my-instance.

For examples of full resource names for Google Cloud services, see https://cloud.google.com/iam/help/troubleshooter/full-resource-names.

permission

string

Required. The IAM permission to check for the specified member and resource.

For a complete list of IAM permissions, see https://cloud.google.com/iam/help/permissions/reference.

For a complete list of predefined IAM roles and the permissions in each role, see https://cloud.google.com/iam/help/roles/reference.

AccessState

Whether a member has a permission for a resource.

Enums
ACCESS_STATE_UNSPECIFIED Reserved for future use.
GRANTED The member has the permission.
NOT_GRANTED The member does not have the permission.
UNKNOWN_CONDITIONAL The member has the permission only if a condition expression evaluates to true.
UNKNOWN_INFO_DENIED The sender of the request does not have access to all of the policies that Policy Troubleshooter needs to evaluate.

ExplainedPolicy

Details about how a specific IAM Policy contributed to the access check.

JSON representation
{
  "access": enum (AccessState),
  "fullResourceName": string,
  "policy": {
    object (Policy)
  },
  "bindingExplanations": [
    {
      object (BindingExplanation)
    }
  ],
  "relevance": enum (HeuristicRelevance)
}
Fields
access

enum (AccessState)

Indicates whether this policy provides the specified permission to the specified member for the specified resource.

This field does not indicate whether the member actually has the permission for the resource. There might be another policy that overrides this policy. To determine whether the member actually has the permission, use the access field in the [TroubleshootIamPolicyResponse][IamChecker.TroubleshootIamPolicyResponse].

fullResourceName

string

The full resource name that identifies the resource. For example, //compute.googleapis.com/projects/my-project/zones/us-central1-a/instances/my-instance.

If the sender of the request does not have access to the policy, this field is omitted.

For examples of full resource names for Google Cloud services, see https://cloud.google.com/iam/help/troubleshooter/full-resource-names.

policy

object (Policy)

The IAM policy attached to the resource.

If the sender of the request does not have access to the policy, this field is empty.

bindingExplanations[]

object (BindingExplanation)

Details about how each binding in the policy affects the member's ability, or inability, to use the permission for the resource.

If the sender of the request does not have access to the policy, this field is omitted.

relevance

enum (HeuristicRelevance)

The relevance of this policy to the overall determination in the [TroubleshootIamPolicyResponse][IamChecker.TroubleshootIamPolicyResponse].

If the sender of the request does not have access to the policy, this field is omitted.

BindingExplanation

Details about how a binding in a policy affects a member's ability to use a permission.

JSON representation
{
  "access": enum (AccessState),
  "role": string,
  "rolePermission": enum (RolePermission),
  "rolePermissionRelevance": enum (HeuristicRelevance),
  "memberships": {
    string: {
      object(AnnotatedMembership)
    },
    ...
  },
  "relevance": enum (HeuristicRelevance),
  "condition": {
    object (Expr)
  }
}
Fields
access

enum (AccessState)

Required. Indicates whether this binding provides the specified permission to the specified member for the specified resource.

This field does not indicate whether the member actually has the permission for the resource. There might be another binding that overrides this binding. To determine whether the member actually has the permission, use the access field in the [TroubleshootIamPolicyResponse][IamChecker.TroubleshootIamPolicyResponse].

role

string

The role that this binding grants. For example, roles/compute.serviceAgent.

For a complete list of predefined IAM roles, as well as the permissions in each role, see https://cloud.google.com/iam/help/roles/reference.

rolePermission

enum (RolePermission)

Indicates whether the role granted by this binding contains the specified permission.

rolePermissionRelevance

enum (HeuristicRelevance)

The relevance of the permission's existence, or nonexistence, in the role to the overall determination for the entire policy.

memberships

map (key: string, value: object (AnnotatedMembership))

Indicates whether each member in the binding includes the member specified in the request, either directly or indirectly. Each key identifies a member in the binding, and each value indicates whether the member in the binding includes the member in the request.

For example, suppose that a binding includes the following members:

  • user:alice@example.com
  • group:product-eng@example.com

You want to troubleshoot access for user:bob@example.com. This user is a member of the group group:product-eng@example.com.

For the first member in the binding, the key is user:alice@example.com, and the membership field in the value is set to MEMBERSHIP_NOT_INCLUDED.

For the second member in the binding, the key is group:product-eng@example.com, and the membership field in the value is set to MEMBERSHIP_INCLUDED.

An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

relevance

enum (HeuristicRelevance)

The relevance of this binding to the overall determination for the entire policy.

condition

object (Expr)

A condition expression that prevents access unless the expression evaluates to true.

To learn about IAM Conditions, see http://cloud.google.com/iam/help/conditions/overview.

RolePermission

Whether a role includes a specific permission.

Enums
ROLE_PERMISSION_UNSPECIFIED Reserved for future use.
ROLE_PERMISSION_INCLUDED The permission is included in the role.
ROLE_PERMISSION_NOT_INCLUDED The permission is not included in the role.
ROLE_PERMISSION_UNKNOWN_INFO_DENIED The sender of the request is not allowed to access the binding.

HeuristicRelevance

The extent to which a single data point contributes to an overall determination.

Enums
HEURISTIC_RELEVANCE_UNSPECIFIED Reserved for future use.
NORMAL The data point has a limited effect on the result. Changing the data point is unlikely to affect the overall determination.
HIGH The data point has a strong effect on the result. Changing the data point is likely to affect the overall determination.