Package types (0.1.5)

API documentation for policysimulator_v1.types package.

Classes

AccessState

Whether a principal has a permission for a resource.

Values: ACCESS_STATE_UNSPECIFIED (0): Default value. This value is unused. GRANTED (1): The principal has the permission. NOT_GRANTED (2): The principal does not have the permission. UNKNOWN_CONDITIONAL (3): The principal has the permission only if a condition expression evaluates to true. UNKNOWN_INFO_DENIED (4): The user who created the Replay does not have access to all of the policies that Policy Simulator needs to evaluate.

AccessStateDiff

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

AccessTuple

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

BindingExplanation

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

CreateReplayRequest

Request message for Simulator.CreateReplay.

ExplainedAccess

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

ExplainedPolicy

Details about how a specific IAM Policy][google.iam.v1.Policy] contributed to the access check.

GetReplayRequest

Request message for Simulator.GetReplay.

HeuristicRelevance

The extent to which a single data point, such as the existence of a binding or whether a binding includes a specific principal, contributes to an overall determination.

Values: HEURISTIC_RELEVANCE_UNSPECIFIED (0): Default value. This value is unused. NORMAL (1): The data point has a limited effect on the result. Changing the data point is unlikely to affect the overall determination. HIGH (2): The data point has a strong effect on the result. Changing the data point is likely to affect the overall determination.

ListReplayResultsRequest

Request message for Simulator.ListReplayResults.

ListReplayResultsResponse

Response message for Simulator.ListReplayResults.

Replay

A resource describing a Replay, or simulation.

ReplayConfig

The configuration used for a Replay.

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 principal's access could change if the proposed policies were applied.

ReplayOperationMetadata

Metadata about a Replay operation.

ReplayResult

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

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields