Method: iam.troubleshoot

Checks whether a principal has a specific permission for a specific resource, and explains why the principal does or doesn't have that permission.

HTTP request

POST https://policytroubleshooter.googleapis.com/v3beta/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 principal has a permission for a resource.

Response body

Response for iam.troubleshoot.

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

JSON representation 
{
  "overallAccessState": enum (OverallAccessState),
  "accessTuple": {
    object (AccessTuple)
  },
  "allowPolicyExplanation": {
    object (AllowPolicyExplanation)
  },
  "denyPolicyExplanation": {
    object (DenyPolicyExplanation)
  },
  "pabPolicyExplanation": {
    object (PABPolicyExplanation)
  }
}
Fields
overallAccessState

enum (OverallAccessState)

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

object (AccessTuple)

The access tuple from the request, including any provided context used to evaluate the condition.
allowPolicyExplanation

object (AllowPolicyExplanation)

An explanation of how the applicable IAM allow policies affect the final access state.
denyPolicyExplanation

object (DenyPolicyExplanation)

An explanation of how the applicable IAM deny policies affect the final access state.
pabPolicyExplanation

object (PABPolicyExplanation)

An explanation of how the applicable Principal Access Boundary policies affect the final access state.

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 principal, resource, and permission to check.

JSON representation 
{
  "principal": string,
  "fullResourceName": string,
  "permission": string,
  "permissionFqdn": string,
  "conditionContext": {
    object (ConditionContext)
  }
}
Fields
principal

string

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

The principal must be a Google Account or a service account. Other types of principals 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, either in the v1 permission format or the v2 permission format.

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

For a list of IAM permissions in the v2 format, see https://cloud.google.com/iam/help/deny/supported-permissions.

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

string

Output only. The permission that Policy Troubleshooter checked for, in the v2 format.
conditionContext

object (ConditionContext)

Optional. Additional context for the request, such as the request time or IP address. This context allows Policy Troubleshooter to troubleshoot conditional role bindings and deny rules.

ConditionContext

Additional context for troubleshooting conditional role bindings and deny rules.

JSON representation 
{
  "resource": {
    object (Resource)
  },
  "destination": {
    object (Peer)
  },
  "request": {
    object (Request)
  },
  "effectiveTags": [
    {
      object (EffectiveTag)
    }
  ]
}
Fields
resource

object (Resource)

Represents a target resource that is involved with a network activity. If multiple resources are involved with an activity, this must be the primary one.
destination

object (Peer)

The destination of a network activity, such as accepting a TCP connection. In a multi-hop network activity, the destination represents the receiver of the last hop.
request

object (Request)

Represents a network request, such as an HTTP request.
effectiveTags[]

object (EffectiveTag)

Output only. The effective tags on the resource. The effective tags are fetched during troubleshooting.

Resource

Core attributes for a resource. A resource is an addressable (named) entity provided by the destination service. For example, a Compute Engine instance.

JSON representation 
{
  "service": string,
  "name": string,
  "type": string
}
Fields
service

string

The name of the service that this resource belongs to, such as compute.googleapis.com. The service name might not match the DNS hostname that actually serves the request.

For a full list of resource service values, see https://cloud.google.com/iam/help/conditions/resource-services
name

string

The stable identifier (name) of a resource on the service. A resource can be logically identified as //{resource.service}/{resource.name}. Unlike the resource URI, the resource name doesn't contain any protocol and version information.

For a list of full resource name formats, see https://cloud.google.com/iam/help/troubleshooter/full-resource-names
type

string

The type of the resource, in the format {service}/{kind}.

For a full list of resource type values, see https://cloud.google.com/iam/help/conditions/resource-types

Peer

This message defines attributes for a node that handles a network request. The node can be either a service or an application that sends, forwards, or receives the request. Service peers should fill in principal and labels as appropriate.

JSON representation 
{
  "ip": string,
  "port": string
}
Fields
ip

string

The IPv4 or IPv6 address of the peer.
port

string (int64 format)

The network port of the peer.

Request

This message defines attributes for an HTTP request. If the actual request is not an HTTP request, the runtime system should try to map the actual request to an equivalent HTTP request.

JSON representation 
{
  "receiveTime": string
}
Fields
receiveTime

string (Timestamp format)

Optional. The timestamp when the destination service receives the first byte of the request.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".

EffectiveTag

A tag that applies to a resource during policy evaluation. Tags can be either directly bound to a resource or inherited from its ancestor. EffectiveTag contains the name and namespaced_name of the tag value and tag key, with additional fields of inherited to indicate the inheritance status of the effective tag.

JSON representation 
{
  "tagValue": string,
  "namespacedTagValue": string,
  "tagKey": string,
  "namespacedTagKey": string,
  "tagKeyParentName": string,
  "inherited": boolean
}
Fields
tagValue

string

Output only. Resource name for TagValue in the format tagValues/456.
namespacedTagValue

string

Output only. The namespaced name of the TagValue. Can be in the form {organizationId}/{tag_key_short_name}/{tag_value_short_name} or {projectId}/{tag_key_short_name}/{tag_value_short_name} or {projectNumber}/{tag_key_short_name}/{tag_value_short_name}.
tagKey

string

Output only. The name of the TagKey, in the format tagKeys/{id}, such as tagKeys/123.
namespacedTagKey

string

Output only. The namespaced name of the TagKey. Can be in the form {organizationId}/{tag_key_short_name} or {projectId}/{tag_key_short_name} or {projectNumber}/{tag_key_short_name}.
tagKeyParentName

string

The parent name of the tag key. Must be in the format organizations/{organizationId} or projects/{projectNumber}
inherited

boolean

Output only. Indicates the inheritance status of a tag value attached to the given resource. If the tag value is inherited from one of the resource's ancestors, inherited will be true. If false, then the tag value is directly attached to the resource, inherited will be false.

OverallAccessState

Whether the principal has the permission on the resource.

Enums
OVERALL_ACCESS_STATE_UNSPECIFIED Not specified.
CAN_ACCESS The principal has the permission.
CANNOT_ACCESS The principal doesn't have the permission.
UNKNOWN_INFO The principal might have the permission, but the sender can't access all of the information needed to fully evaluate the principal's access.
UNKNOWN_CONDITIONAL The principal might have the permission, but Policy Troubleshooter can't fully evaluate the principal's access because the sender didn't provide the required context to evaluate the condition.

AllowPolicyExplanation

Details about how the relevant IAM allow policies affect the final access state.

JSON representation 
{
  "allowAccessState": enum (AllowAccessState),
  "explainedPolicies": [
    {
      object (ExplainedAllowPolicy)
    }
  ],
  "relevance": enum (HeuristicRelevance)
}
Fields
allowAccessState

enum (AllowAccessState)

Indicates whether the principal has the specified permission for the specified resource, based on evaluating all applicable IAM allow policies.
explainedPolicies[]

object (ExplainedAllowPolicy)

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

The list of policies includes the policy for the resource itself, as well as allow 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.
relevance

enum (HeuristicRelevance)

The relevance of the allow policy type to the overall access state.

AllowAccessState

Whether IAM allow policies gives the principal the permission.

Enums
ALLOW_ACCESS_STATE_UNSPECIFIED Not specified.
ALLOW_ACCESS_STATE_GRANTED The allow policy gives the principal the permission.
ALLOW_ACCESS_STATE_NOT_GRANTED The allow policy doesn't give the principal the permission.
ALLOW_ACCESS_STATE_UNKNOWN_CONDITIONAL The allow policy gives the principal the permission if a condition expression evaluate to true. However, the sender of the request didn't provide enough context for Policy Troubleshooter to evaluate the condition expression.
ALLOW_ACCESS_STATE_UNKNOWN_INFO The sender of the request doesn't have access to all of the allow policies that Policy Troubleshooter needs to evaluate the principal's access.

ExplainedAllowPolicy

Details about how a specific IAM allow policy contributed to the final access state.

JSON representation 
{
  "allowAccessState": enum (AllowAccessState),
  "fullResourceName": string,
  "bindingExplanations": [
    {
      object (AllowBindingExplanation)
    }
  ],
  "relevance": enum (HeuristicRelevance),
  "policy": {
    object (Policy)
  }
}
Fields
allowAccessState

enum (AllowAccessState)

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

This field does not indicate whether the principal actually has the permission for the resource. There might be another policy that overrides this policy. To determine whether the principal actually has the permission, use the overallAccessState field in the 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.
bindingExplanations[]

object (AllowBindingExplanation)

Details about how each role binding in the policy affects the principal's ability, or inability, to use the permission for the resource. The order of the role bindings matches the role binding order in the policy.

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 access state in the TroubleshootIamPolicyResponse.

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

object (Policy)

The IAM allow policy attached to the resource.

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

AllowBindingExplanation

Details about how a role binding in an allow policy affects a principal's ability to use a permission.

JSON representation 
{
  "allowAccessState": enum (AllowAccessState),
  "role": string,
  "rolePermission": enum (RolePermissionInclusionState),
  "rolePermissionRelevance": enum (HeuristicRelevance),
  "combinedMembership": {
    object (AnnotatedAllowMembership)
  },
  "memberships": {
    string: {
      object (AnnotatedAllowMembership)
    },
    ...
  },
  "relevance": enum (HeuristicRelevance),
  "condition": {
    object (Expr)
  },
  "conditionExplanation": {
    object (ConditionExplanation)
  }
}
Fields
allowAccessState

enum (AllowAccessState)

Required. Indicates whether this role binding gives the specified permission to the specified principal on the specified resource.

This field does not indicate whether the principal actually has the permission on the resource. There might be another role binding that overrides this role binding. To determine whether the principal actually has the permission, use the overallAccessState field in the TroubleshootIamPolicyResponse.
role

string

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

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 (RolePermissionInclusionState)

Indicates whether the role granted by this role 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.
combinedMembership

object (AnnotatedAllowMembership)

The combined result of all memberships. Indicates if the principal is included in any role binding, either directly or indirectly.
memberships

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

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

For example, suppose that a role binding includes the following principals:

  • 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 principal in the role binding, the key is user:alice@example.com, and the membership field in the value is set to NOT_INCLUDED.

For the second principal in the role binding, the key is group:product-eng@example.com, and the membership field in the value is set to 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 role binding to the overall determination for the entire policy.
condition

object (Expr)

A condition expression that specifies when the role binding grants access.

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

object (ConditionExplanation)

Condition evaluation state for this role binding.

RolePermissionInclusionState

Whether a role includes a specific permission.

Enums
ROLE_PERMISSION_INCLUSION_STATE_UNSPECIFIED Not specified.
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 The sender of the request is not allowed to access the role definition.

HeuristicRelevance

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

Enums
HEURISTIC_RELEVANCE_UNSPECIFIED Not specified.
HEURISTIC_RELEVANCE_NORMAL The data point has a limited effect on the result. Changing the data point is unlikely to affect the overall determination.
HEURISTIC_RELEVANCE_HIGH The data point has a strong effect on the result. Changing the data point is likely to affect the overall determination.

AnnotatedAllowMembership

Details about whether the role binding includes the principal.

JSON representation 
{
  "membership": enum (MembershipMatchingState),
  "relevance": enum (HeuristicRelevance)
}
Fields
membership

enum (MembershipMatchingState)

Indicates whether the role binding includes the principal.
relevance

enum (HeuristicRelevance)

The relevance of the principal's status to the overall determination for the role binding.

MembershipMatchingState

Whether the principal in the request matches the principal in the policy.

Enums
MEMBERSHIP_MATCHING_STATE_UNSPECIFIED Not specified.
MEMBERSHIP_MATCHED

The principal in the request matches the principal in the policy. The principal can be included directly or indirectly:

  • A principal is included directly if that principal is listed in the role binding.
  • A principal is included indirectly if that principal is in a Google group, Google Workspace account, or Cloud Identity domain that is listed in the policy.
MEMBERSHIP_NOT_MATCHED The principal in the request doesn't match the principal in the policy.
MEMBERSHIP_UNKNOWN_INFO The principal in the policy is a group or domain, and the sender of the request doesn't have permission to view whether the principal in the request is a member of the group or domain.
MEMBERSHIP_UNKNOWN_UNSUPPORTED The principal is an unsupported type.

ConditionExplanation

Explanation for how a condition affects a principal's access

JSON representation 
{
  "value": value,
  "errors": [
    {
      object (Status)
    }
  ],
  "evaluationStates": [
    {
      object (EvaluationState)
    }
  ]
}
Fields
value

value (Value format)

Value of the condition.
errors[]

object (Status)

Any errors that prevented complete evaluation of the condition expression.
evaluationStates[]

object (EvaluationState)

The value of each statement of the condition expression. The value can be true, false, or null. The value is null if the statement can't be evaluated.

EvaluationState

Evaluated state of a condition expression.

JSON representation 
{
  "start": integer,
  "end": integer,
  "value": value,
  "errors": [
    {
      object (Status)
    }
  ]
}
Fields
start

integer

Start position of an expression in the condition, by character.
end

integer

End position of an expression in the condition, by character, end included, for example: the end position of the first part of a==b || c==d would be 4.
value

value (Value format)

Value of this expression.
errors[]

object (Status)

Any errors that prevented complete evaluation of the condition expression.

DenyPolicyExplanation

Details about how the relevant IAM deny policies affect the final access state.

JSON representation 
{
  "denyAccessState": enum (DenyAccessState),
  "explainedResources": [
    {
      object (ExplainedDenyResource)
    }
  ],
  "relevance": enum (HeuristicRelevance),
  "permissionDeniable": boolean
}
Fields
denyAccessState

enum (DenyAccessState)

Indicates whether the principal is denied the specified permission for the specified resource, based on evaluating all applicable IAM deny policies.
explainedResources[]

object (ExplainedDenyResource)

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

The list of resources includes the policy for the resource itself, as well as policies that are inherited from higher levels of the resource hierarchy, including the organization, the folder, and the project. The order of the resources starts from the resource and climbs up the resource hierarchy.

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

enum (HeuristicRelevance)

The relevance of the deny policy result to the overall access state.
permissionDeniable

boolean

Indicates whether the permission to troubleshoot is supported in deny policies.

DenyAccessState

Whether IAM deny policies deny the principal the permission.

Enums
DENY_ACCESS_STATE_UNSPECIFIED Not specified.
DENY_ACCESS_STATE_DENIED The deny policy denies the principal the permission.
DENY_ACCESS_STATE_NOT_DENIED The deny policy doesn't deny the principal the permission.
DENY_ACCESS_STATE_UNKNOWN_CONDITIONAL The deny policy denies the principal the permission if a condition expression evaluates to true. However, the sender of the request didn't provide enough context for Policy Troubleshooter to evaluate the condition expression.
DENY_ACCESS_STATE_UNKNOWN_INFO The sender of the request does not have access to all of the deny policies that Policy Troubleshooter needs to evaluate the principal's access.

ExplainedDenyResource

Details about how a specific resource contributed to the deny policy evaluation.

JSON representation 
{
  "denyAccessState": enum (DenyAccessState),
  "fullResourceName": string,
  "explainedPolicies": [
    {
      object (ExplainedDenyPolicy)
    }
  ],
  "relevance": enum (HeuristicRelevance)
}
Fields
denyAccessState

enum (DenyAccessState)

Required. Indicates whether any policies attached to this resource deny the specific permission to the specified principal for the specified resource.

This field does not indicate whether the principal actually has the permission for the resource. There might be another policy that overrides this policy. To determine whether the principal actually has the permission, use the overallAccessState field in the 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.
explainedPolicies[]

object (ExplainedDenyPolicy)

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

enum (HeuristicRelevance)

The relevance of this policy to the overall access state in the TroubleshootIamPolicyResponse.

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

ExplainedDenyPolicy

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

JSON representation 
{
  "denyAccessState": enum (DenyAccessState),
  "policy": {
    object (Policy)
  },
  "ruleExplanations": [
    {
      object (DenyRuleExplanation)
    }
  ],
  "relevance": enum (HeuristicRelevance)
}
Fields
denyAccessState

enum (DenyAccessState)

Required. Indicates whether this policy denies the specified permission to the specified principal for the specified resource.

This field does not indicate whether the principal actually has the permission for the resource. There might be another policy that overrides this policy. To determine whether the principal actually has the permission, use the overallAccessState field in the TroubleshootIamPolicyResponse.
policy

object (Policy)

The IAM deny policy attached to the resource.

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

object (DenyRuleExplanation)

Details about how each rule in the policy affects the principal's inability to use the permission for the resource. The order of the deny rule matches the order of the rules in the deny policy.

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 access state in the TroubleshootIamPolicyResponse.

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

DenyRuleExplanation

Details about how a deny rule in a deny policy affects a principal's ability to use a permission.

JSON representation 
{
  "denyAccessState": enum (DenyAccessState),
  "combinedDeniedPermission": {
    object (AnnotatedPermissionMatching)
  },
  "deniedPermissions": {
    string: {
      object (AnnotatedPermissionMatching)
    },
    ...
  },
  "combinedExceptionPermission": {
    object (AnnotatedPermissionMatching)
  },
  "exceptionPermissions": {
    string: {
      object (AnnotatedPermissionMatching)
    },
    ...
  },
  "combinedDeniedPrincipal": {
    object (AnnotatedDenyPrincipalMatching)
  },
  "deniedPrincipals": {
    string: {
      object (AnnotatedDenyPrincipalMatching)
    },
    ...
  },
  "combinedExceptionPrincipal": {
    object (AnnotatedDenyPrincipalMatching)
  },
  "exceptionPrincipals": {
    string: {
      object (AnnotatedDenyPrincipalMatching)
    },
    ...
  },
  "relevance": enum (HeuristicRelevance),
  "condition": {
    object (Expr)
  },
  "conditionExplanation": {
    object (ConditionExplanation)
  }
}
Fields
denyAccessState

enum (DenyAccessState)

Required. Indicates whether this rule denies the specified permission to the specified principal for the specified resource.

This field does not indicate whether the principal is actually denied on the permission for the resource. There might be another rule that overrides this rule. To determine whether the principal actually has the permission, use the overallAccessState field in the TroubleshootIamPolicyResponse.
combinedDeniedPermission

object (AnnotatedPermissionMatching)

Indicates whether the permission in the request is listed as a denied permission in the deny rule.
deniedPermissions

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

Lists all denied permissions in the deny rule and indicates whether each permission matches the permission in the request.

Each key identifies a denied permission in the rule, and each value indicates whether the denied permission matches the permission in the request.

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

object (AnnotatedPermissionMatching)

Indicates whether the permission in the request is listed as an exception permission in the deny rule.
exceptionPermissions

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

Lists all exception permissions in the deny rule and indicates whether each permission matches the permission in the request.

Each key identifies a exception permission in the rule, and each value indicates whether the exception permission matches the permission in the request.

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

object (AnnotatedDenyPrincipalMatching)

Indicates whether the principal is listed as a denied principal in the deny rule, either directly or through membership in a principal set.
deniedPrincipals

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

Lists all denied principals in the deny rule and indicates whether each principal matches the principal in the request, either directly or through membership in a principal set.

Each key identifies a denied principal in the rule, and each value indicates whether the denied principal matches the principal in the request.

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

object (AnnotatedDenyPrincipalMatching)

Indicates whether the principal is listed as an exception principal in the deny rule, either directly or through membership in a principal set.
exceptionPrincipals

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

Lists all exception principals in the deny rule and indicates whether each principal matches the principal in the request, either directly or through membership in a principal set.

Each key identifies a exception principal in the rule, and each value indicates whether the exception principal matches the principal in the request.

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

enum (HeuristicRelevance)

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

object (Expr)

A condition expression that specifies when the deny rule denies the principal access.

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

object (ConditionExplanation)

Condition evaluation state for this role binding.

AnnotatedPermissionMatching

Details about whether the permission in the request is denied by the deny rule.

JSON representation 
{
  "permissionMatchingState": enum (PermissionPatternMatchingState),
  "relevance": enum (HeuristicRelevance)
}
Fields
permissionMatchingState

enum (PermissionPatternMatchingState)

Indicates whether the permission in the request is denied by the deny rule.
relevance

enum (HeuristicRelevance)

The relevance of the permission status to the overall determination for the rule.

PermissionPatternMatchingState

Whether the permission in the request matches the permission in the policy.

Enums
PERMISSION_PATTERN_MATCHING_STATE_UNSPECIFIED Not specified.
PERMISSION_PATTERN_MATCHED The permission in the request matches the permission in the policy.
PERMISSION_PATTERN_NOT_MATCHED The permission in the request matches the permission in the policy.

AnnotatedDenyPrincipalMatching

Details about whether the principal in the request is listed as a denied principal in the deny rule, either directly or through membership in a principal set.

JSON representation 
{
  "membership": enum (MembershipMatchingState),
  "relevance": enum (HeuristicRelevance)
}
Fields
membership

enum (MembershipMatchingState)

Indicates whether the principal is listed as a denied principal in the deny rule, either directly or through membership in a principal set.
relevance

enum (HeuristicRelevance)

The relevance of the principal's status to the overall determination for the role binding.

PABPolicyExplanation

Details about how the relevant Principal Access Boundary policies affect the overall access state.

JSON representation 
{
  "principalAccessBoundaryAccessState": enum (PABAccessState),
  "explainedBindingsAndPolicies": [
    {
      object (ExplainedPABBindingAndPolicy)
    }
  ],
  "relevance": enum (HeuristicRelevance)
}
Fields
principalAccessBoundaryAccessState

enum (PABAccessState)

Output only. Indicates whether the principal is allowed to access specified resource, based on evaluating all applicable Principal Access Boundary bindings and policies.
explainedBindingsAndPolicies[]

object (ExplainedPABBindingAndPolicy)

List of Principal Access Boundary policies and bindings that are applicable to the principal's access state, with annotations to indicate how each binding and policy contributes to the overall access state.
relevance

enum (HeuristicRelevance)

The relevance of the Principal Access Boundary access state to the overall access state.

PABAccessState

Whether a Principal Access Boundary component allows the principal to access the specified resource.

A PAB component refers to a PAB rule, a PAB policy, a PAB policy and binding pair, all PAB policies bound to a target, or PAB overall. This is because this enum is shared across all these messages.

Enums
PAB_ACCESS_STATE_UNSPECIFIED Not specified.
PAB_ACCESS_STATE_ALLOWED The PAB component allows the principal's access to the specified resource.
PAB_ACCESS_STATE_NOT_ALLOWED The PAB component doesn't allow the principal's access to the specified resource.
PAB_ACCESS_STATE_NOT_ENFORCED

The PAB component is not enforced on the principal, or the specified resource.

This state refers to 2 specific scenarios:

  • IAM doesn't enforce the specified permission at the PAB policy's enforcement version, so the PAB policy can't block access.
  • The binding doesn't apply to the principal, so the policy is not enforced.
PAB_ACCESS_STATE_UNKNOWN_INFO The sender of the request does not have access to the PAB component, or the relevant data to explain the PAB component.

ExplainedPABBindingAndPolicy

Details about how a Principal Access Boundary binding and policy contributes to the Principal Access Boundary explanation, with annotations to indicate how the binding and policy contribute to the overall access state.

JSON representation 
{
  "bindingAndPolicyAccessState": enum (PABAccessState),
  "explainedPolicyBinding": {
    object (ExplainedPolicyBinding)
  },
  "explainedPolicy": {
    object (ExplainedPABPolicy)
  },
  "relevance": enum (HeuristicRelevance)
}
Fields
bindingAndPolicyAccessState

enum (PABAccessState)

Output only. Indicates whether the principal is allowed to access the specified resource based on evaluating the binding and policy.
explainedPolicyBinding

object (ExplainedPolicyBinding)

Details about how this binding contributes to the Principal Access Boundary explanation, with annotations to indicate how the binding contributes to the overall access state.
explainedPolicy

object (ExplainedPABPolicy)

Optional. Details about how this policy contributes to the Principal Access Boundary explanation, with annotations to indicate how the policy contributes to the overall access state.

If the caller doesn't have permission to view the policy in the binding, this field is omitted.
relevance

enum (HeuristicRelevance)

The relevance of this Principal Access Boundary binding and policy to the overall access state.

ExplainedPolicyBinding

Details about how a policy binding contributes to the policy explanation, with annotations to indicate how the policy binding contributes to the overall access state.

JSON representation 
{
  "policyBindingState": enum (PolicyBindingState),
  "policyBinding": {
    object (PolicyBinding)
  },
  "conditionExplanation": {
    object (ConditionExplanation)
  },
  "relevance": enum (HeuristicRelevance)
}
Fields
policyBindingState

enum (PolicyBindingState)

Output only. Indicates whether the policy binding takes effect.
policyBinding

object (PolicyBinding)

The policy binding that is explained.
conditionExplanation

object (ConditionExplanation)

Optional. Explanation of the condition in the policy binding.

If the policy binding doesn't have a condition, this field is omitted.
relevance

enum (HeuristicRelevance)

The relevance of this policy binding to the overall access state.

PolicyBindingState

Whether the policy binding is enforced.

The target of a policy binding can be a principal (for PAB policies) or a resource (for Access Policies).

Enums
POLICY_BINDING_STATE_UNSPECIFIED An error occurred when checking whether the policy binding is enforced.
POLICY_BINDING_STATE_ENFORCED The policy binding is enforced.
POLICY_BINDING_STATE_NOT_ENFORCED The policy binding is not enforced.

PolicyBinding

IAM policy binding

JSON representation 
{
  "name": string,
  "uid": string,
  "etag": string,
  "displayName": string,
  "annotations": {
    string: string,
    ...
  },
  "target": {
    object (Target)
  },
  "policyKind": enum (PolicyKind),
  "policy": string,
  "policyUid": string,
  "condition": {
    object (Expr)
  },
  "createTime": string,
  "updateTime": string
}
Fields
name

string

Identifier. The name of the policy binding, in the format {binding_parent/locations/{location}/policyBindings/{policy_binding_id}. The binding parent is the closest Resource Manager resource (i.e., Project, Folder or Organization) to the binding target.

Format:

  • projects/{projectId}/locations/{location}/policyBindings/{policy_binding_id} // NOLINT
  • projects/{projectNumber}/locations/{location}/policyBindings/{policy_binding_id} // NOLINT
  • folders/{folderId}/locations/{location}/policyBindings/{policy_binding_id} // NOLINT
  • organizations/{organizationId}/locations/{location}/policyBindings/{policy_binding_id} // NOLINT
uid

string

Output only. The globally unique ID of the policy binding. Assigned when the policy binding is created.
etag

string

Optional. The etag for the policy binding. If this is provided on update, it must match the server's etag.
displayName

string

Optional. The description of the policy binding. Must be less than or equal to 63 characters.
annotations

map (key: string, value: string)

Optional. User defined annotations. See https://google.aip.dev/148#annotations for more details such as format and size limitations

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

object (Target)

Required. Immutable. Target is the full resource name of the resource to which the policy will be bound. Immutable once set.
policyKind

enum (PolicyKind)

Immutable. The kind of the policy to attach in this binding. This field must be one of the following:

  • Left empty (will be automatically set to the policy kind)
  • The input policy kind
policy

string

Required. Immutable. The resource name of the policy to be bound. The binding parent and policy must belong to the same Organization (or Project).
policyUid

string

Output only. The globally unique ID of the policy to be bound.
condition

object (Expr)

Optional. Condition can either be a principal condition or a resource condition. It depends on the type of target, the policy it is attached to, and/or the expression itself. When set, the expression field in the Expr must include from 1 to 10 subexpressions, joined by the "||"(Logical OR), "&&"(Logical AND) or "!"(Logical NOT) operators and cannot contain more than 250 characters. Allowed operations for principal.subject:

  • principal.subject == <principal subject string>
  • principal.subject != <principal subject string>
  • principal.subject in [<list of principal subjects>]
  • principal.subject.startsWith(<string>)
  • principal.subject.endsWith(<string>)

Allowed operations for principal.type:

  • principal.type == <principal type string>
  • principal.type != <principal type string>
  • principal.type in [<list of principal types>]

Supported principal types are Workspace, Workforce Pool, Workload Pool and Service Account. Allowed string must be one of:

  • iam.googleapis.com/WorkspaceIdentity
  • iam.googleapis.com/WorkforcePoolIdentity
  • iam.googleapis.com/WorkloadPoolIdentity
  • iam.googleapis.com/ServiceAccount

When the bound policy is a principal access boundary policy, the only supported attributes in any subexpression are principal.type and principal.subject. An example expression is: "principal.type == 'iam.googleapis.com/ServiceAccount'" or "principal.subject == 'bob@example.com'".
createTime

string (Timestamp format)

Output only. The time when the policy binding was created.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
updateTime

string (Timestamp format)

Output only. The time when the policy binding was most recently updated.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".

Target

Target is the full resource name of the resource to which the policy will be bound. Immutable once set.

JSON representation 
{

  // Union field target can be only one of the following:
  "principalSet": string
  // End of list of possible types for union field target.
}
Fields

Union field target.

target can be only one of the following:
principalSet

string

Immutable. Full Resource Name used for principal access boundary policy bindings Examples:

  • Organization: //cloudresourcemanager.googleapis.com/organizations/ORGANIZATION_ID
  • Folder: //cloudresourcemanager.googleapis.com/folders/FOLDER_ID
  • Project:
    • //cloudresourcemanager.googleapis.com/projects/PROJECT_NUMBER
    • //cloudresourcemanager.googleapis.com/projects/PROJECT_ID
  • Workload Identity Pool: //iam.googleapis.com/projects/PROJECT_NUMBER/locations/LOCATION/workloadIdentityPools/WORKLOAD_POOL_ID // NOLINT
  • Workforce Identity: //iam.googleapis.com/locations/global/workforcePools/WORKFORCE_POOL_ID
  • Workspace Identity: //iam.googleapis.com/locations/global/workspace/WORKSPACE_ID

PolicyKind

Different policy kinds supported in this binding.

Enums
POLICY_KIND_UNSPECIFIED Unspecified policy kind; Not a valid state
PRINCIPAL_ACCESS_BOUNDARY Principal access boundary policy kind

ExplainedPABPolicy

Details about how a Principal Access Boundary policy contributes to the explanation, with annotations to indicate how the policy contributes to the overall access state.

JSON representation 
{
  "policyAccessState": enum (PABAccessState),
  "policy": {
    object (PrincipalAccessBoundaryPolicy)
  },
  "policyVersion": {
    object (ExplainedPABPolicyVersion)
  },
  "explainedRules": [
    {
      object (ExplainedPABRule)
    }
  ],
  "relevance": enum (HeuristicRelevance)
}
Fields
policyAccessState

enum (PABAccessState)

Output only. Indicates whether the policy allows access to the specified resource.
policy

object (PrincipalAccessBoundaryPolicy)

The policy that is explained.
policyVersion

object (ExplainedPABPolicyVersion)

Output only. Explanation of the Principal Access Boundary policy's version.
explainedRules[]

object (ExplainedPABRule)

List of Principal Access Boundary rules that were explained to check the principal's access to specified resource, with annotations to indicate how each rule contributes to the overall access state.
relevance

enum (HeuristicRelevance)

The relevance of this policy to the overall access state.

PrincipalAccessBoundaryPolicy

An IAM principal access boundary policy resource.

JSON representation 
{
  "name": string,
  "uid": string,
  "etag": string,
  "displayName": string,
  "annotations": {
    string: string,
    ...
  },
  "createTime": string,
  "updateTime": string,
  "details": {
    object (PrincipalAccessBoundaryPolicyDetails)
  }
}
Fields
name

string

Identifier. The resource name of the principal access boundary policy.

The following format is supported: organizations/{organizationId}/locations/{location}/principalAccessBoundaryPolicies/{policyId}
uid

string

Output only. The globally unique ID of the principal access boundary policy.
etag

string

Optional. The etag for the principal access boundary. If this is provided on update, it must match the server's etag.
displayName

string

Optional. The description of the principal access boundary policy. Must be less than or equal to 63 characters.
annotations

map (key: string, value: string)

Optional. User defined annotations. See https://google.aip.dev/148#annotations for more details such as format and size limitations

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

string (Timestamp format)

Output only. The time when the principal access boundary policy was created.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
updateTime

string (Timestamp format)

Output only. The time when the principal access boundary policy was most recently updated.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
details

object (PrincipalAccessBoundaryPolicyDetails)

Optional. The details for the principal access boundary policy.

PrincipalAccessBoundaryPolicyDetails

Principal access boundary policy details

JSON representation 
{
  "rules": [
    {
      object (PrincipalAccessBoundaryPolicyRule)
    }
  ],
  "enforcementVersion": string
}
Fields
rules[]

object (PrincipalAccessBoundaryPolicyRule)

Required. A list of principal access boundary policy rules. The number of rules in a policy is limited to 500.
enforcementVersion

string

Optional. The version number that indicates which Google Cloud services are included in the enforcement (e.g. "latest", "1", ...). If empty, the PAB policy version will be set to the current latest version, and this version won't get updated when new versions are released.

PrincipalAccessBoundaryPolicyRule

Principal access boundary policy rule that defines the resource boundary.

JSON representation 
{
  "description": string,
  "resources": [
    string
  ],
  "effect": enum (Effect)
}
Fields
description

string

Optional. The description of the principal access boundary policy rule. Must be less than or equal to 256 characters.
resources[]

string

Required. A list of Cloud Resource Manager resources. The resource and all the descendants are included. The number of resources in a policy is limited to 500 across all rules.

The following resource types are supported:

  • Organizations, such as //cloudresourcemanager.googleapis.com/organizations/123.
  • Folders, such as //cloudresourcemanager.googleapis.com/folders/123.
  • Projects, such as //cloudresourcemanager.googleapis.com/projects/123 or //cloudresourcemanager.googleapis.com/projects/my-project-id.
effect

enum (Effect)

Required. The access relationship of principals to the resources in this rule.

Effect

An effect to describe the access relationship.

Enums
EFFECT_UNSPECIFIED Effect unspecified.
ALLOW Allows access to the resources in this rule.

ExplainedPABPolicyVersion

Details about how a Principal Access Boundary policy's version contributes to the policy's enforcement state.

JSON representation 
{
  "version": integer,
  "enforcementState": enum (PABPolicyEnforcementState)
}
Fields
version

integer

Output only. The actual version of the policy. - If the policy uses static version, this field is the chosen static version. - If the policy uses dynamic version, this field is the effective latest version.
enforcementState

enum (PABPolicyEnforcementState)

Output only. Indicates whether the policy is enforced based on its version.

PABPolicyEnforcementState

Whether a Principal Access Boundary policy is enforced based on its version.

Enums
PAB_POLICY_ENFORCEMENT_STATE_UNSPECIFIED An error occurred when checking whether a Principal Access Boundary policy is enforced based on its version.
PAB_POLICY_ENFORCEMENT_STATE_ENFORCED The Principal Access Boundary policy is enforced based on its version.
PAB_POLICY_ENFORCEMENT_STATE_NOT_ENFORCED The Principal Access Boundary policy is not enforced based on its version.

ExplainedPABRule

Details about how a Principal Access Boundary rule contributes to the explanation, with annotations to indicate how the rule contributes to the overall access state.

JSON representation 
{
  "ruleAccessState": enum (PABAccessState),
  "effect": enum (Effect),
  "combinedResourceInclusionState": enum (ResourceInclusionState),
  "explainedResources": [
    {
      object (ExplainedResource)
    }
  ],
  "relevance": enum (HeuristicRelevance)
}
Fields
ruleAccessState

enum (PABAccessState)

Output only. Indicates whether the rule allows access to the specified resource.
effect

enum (Effect)

Required. The effect of the rule which describes the access relationship.
combinedResourceInclusionState

enum (ResourceInclusionState)

Output only. Indicates whether any resource of the rule is the specified resource or includes the specified resource.
explainedResources[]

object (ExplainedResource)

List of resources that were explained to check the principal's access to specified resource, with annotations to indicate how each resource contributes to the overall access state.
relevance

enum (HeuristicRelevance)

The relevance of this rule to the overall access state.

ResourceInclusionState

Whether the resource is the specified resource or includes the specified resource.

Enums
RESOURCE_INCLUSION_STATE_UNSPECIFIED An error occurred when checking whether the resource includes the specified resource.
RESOURCE_INCLUSION_STATE_INCLUDED The resource includes the specified resource.
RESOURCE_INCLUSION_STATE_NOT_INCLUDED The resource doesn't include the specified resource.
RESOURCE_INCLUSION_STATE_UNKNOWN_INFO The sender of the request does not have access to the relevant data to check whether the resource includes the specified resource.
RESOURCE_INCLUSION_STATE_UNKNOWN_UNSUPPORTED The resource is of an unsupported type, such as non-CRM resources.

ExplainedResource

Details about how a resource contributes to the explanation, with annotations to indicate how the resource contributes to the overall access state.

JSON representation 
{
  "resourceInclusionState": enum (ResourceInclusionState),
  "resource": string,
  "relevance": enum (HeuristicRelevance)
}
Fields
resourceInclusionState

enum (ResourceInclusionState)

Output only. Indicates whether the resource is the specified resource or includes the specified resource.
resource

string

The full resource name that identifies the resource that is explained.

This can only be a project, a folder, or an organization which is what a PAB rule accepts.
relevance

enum (HeuristicRelevance)

The relevance of this resource to the overall access state.