REST Resource: folders.locations.replays.results

Resource: ReplayResult

The result of replaying a single access tuple against a simulated state.

JSON representation
{
  "name": string,
  "parent": string,
  "accessTuple": {
    object (AccessTuple)
  },
  "lastSeenDate": {
    object (Date)
  },

  // Union field result can be only one of the following:
  "diff": {
    object (ReplayDiff)
  },
  "error": {
    object (Status)
  }
  // End of list of possible types for union field result.
}
Fields
name

string

The resource name of the ReplayResult, in the following format:

{projects|folders|organizations}/{resource-id}/locations/global/replays/{replay-id}/results/{replay-result-id}, where {resource-id} is the ID of the project, folder, or organization that owns the Replay.

Example: projects/my-example-project/locations/global/replays/506a5f7f-38ce-4d7d-8e03-479ce1833c36/results/1234

parent

string

The Replay that the access tuple was included in.

accessTuple

object (AccessTuple)

The access tuple that was replayed. This field includes information about the member, resource, and permission that were involved in the access attempt.

lastSeenDate

object (Date)

The latest date this access tuple was seen in the logs.

Union field result. The result of replaying the access tuple. result can be only one of the following:
diff

object (ReplayDiff)

The difference between the member's access under the current (baseline) policies and the member's access under the proposed (simulated) policies.

This field is only included for access tuples that were successfully replayed and had different results under the current policies and the proposed policies.

error

object (Status)

The error that caused the access tuple replay to fail.

This field is only included for access tuples that were not replayed successfully.

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.

ReplayDiff

The difference between the results of evaluating an access tuple under the current (baseline) policies and under the proposed (simulated) policies. This difference explains how a member's access could change if the proposed policies were applied.

JSON representation
{
  "accessDiff": {
    object (AccessStateDiff)
  }
}
Fields
accessDiff

object (AccessStateDiff)

A summary and comparison of the member's access under the current (baseline) policies and the proposed (simulated) policies for a single access tuple.

The evaluation of the member's access is reported in the AccessState field.

AccessStateDiff

A summary and comparison of the member's access under the current (baseline) policies and the proposed (simulated) policies for a single access tuple.

JSON representation
{
  "baseline": {
    object (ExplainedAccess)
  },
  "simulated": {
    object (ExplainedAccess)
  },
  "accessChange": enum (AccessChangeType)
}
Fields
baseline

object (ExplainedAccess)

The results of evaluating the access tuple under the current (baseline) policies.

If the AccessState couldn't be fully evaluated, this field explains why.

simulated

object (ExplainedAccess)

The results of evaluating the access tuple under the proposed (simulated) policies.

If the AccessState couldn't be fully evaluated, this field explains why.

accessChange

enum (AccessChangeType)

How the member's access, specified in the AccessState field, changed between the current (baseline) policies and proposed (simulated) policies.

ExplainedAccess

Details about how a set of policies, listed in ExplainedPolicy, resulted in a certain AccessState when replaying an access tuple.

JSON representation
{
  "accessState": enum (AccessState),
  "policies": [
    {
      object (ExplainedPolicy)
    }
  ],
  "errors": [
    {
      object (Status)
    }
  ]
}
Fields
accessState

enum (AccessState)

Whether the member in the access tuple has permission to access the resource in the access tuple under the given policies.

policies[]

object (ExplainedPolicy)

If the AccessState is UNKNOWN, this field contains the policies that led to that result.

If the AccessState is GRANTED or NOT_GRANTED, this field is omitted.

errors[]

object (Status)

If the AccessState is UNKNOWN, this field contains a list of errors explaining why the result is UNKNOWN.

If the AccessState is GRANTED or NOT_GRANTED, this field is omitted.

AccessState

Whether a member has a permission for a resource.

Enums
ACCESS_STATE_UNSPECIFIED The access state is not specified.
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 user who created the Replay does not have access to all of the policies that Policy Simulator 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 user who created the Replay 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 user who created the Replay 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 user who created the Replay 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 user who created the Replay 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: {
      "membership": enum,
      "relevance": enum (HeuristicRelevance)
    },
    ...
  },
  "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)

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

The member in the replayed access tuple is 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" }.

memberships[].membership

enum

Indicates whether the binding includes the member.

Valid values of this enum field are:

MEMBERSHIP_UNSPECIFIED

,

MEMBERSHIP_INCLUDED

,

MEMBERSHIP_NOT_INCLUDED

,

MEMBERSHIP_UNKNOWN_INFO_DENIED

,

MEMBERSHIP_UNKNOWN_UNSUPPORTED

memberships[].relevance

enum (HeuristicRelevance)

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

relevance

enum (HeuristicRelevance)

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

condition

object (Expr)

A condition expression that prevents this binding from granting access unless the expression evaluates to true.

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

RolePermission

Whether a role includes a specific permission.

Enums
ROLE_PERMISSION_UNSPECIFIED The inclusion of the permission is 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_DENIED The user who created the Replay is not allowed to access the binding.

HeuristicRelevance

The extent to which a single part of a policy (e.g. a binding or a membership annotation in the binding) 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.

AccessChangeType

How the member's access, specified in the AccessState field, changed between the current (baseline) policies and proposed (simulated) policies.

Enums
ACCESS_CHANGE_TYPE_UNSPECIFIED The access change is unspecified.
NO_CHANGE The member's access did not change. This includes the case where both baseline and simulated are UNKNOWN, but the unknown information is equivalent.
UNKNOWN_CHANGE The member's access under both the current policies and the proposed policies is UNKNOWN, but the unknown information differs between them.
ACCESS_REVOKED The member had access under the current policies (GRANTED), but will no longer have access after the proposed changes (NOT_GRANTED).
ACCESS_GAINED The member did not have access under the current policies (NOT_GRANTED), but will have access after the proposed changes (GRANTED).
ACCESS_MAYBE_REVOKED

This result can occur for the following reasons:

  • The member had access under the current policies (GRANTED), but their access after the proposed changes is UNKNOWN.

  • The member's access under the current policies is UNKNOWN, but they will not have access after the proposed changes (NOT_GRANTED).

ACCESS_MAYBE_GAINED

This result can occur for the following reasons:

  • The member did not have access under the current policies (NOT_GRANTED), but their access after the proposed changes is UNKNOWN.

  • The member's access under the current policies is UNKNOWN, but they will have access after the proposed changes (GRANTED).

Methods

list

Lists the results of running a Replay.