Policy Simulator v1 API - Namespace Google.Cloud.PolicySimulator.V1 (1.3.0)

Classes

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.

AccessStateDiff.Types

Container for nested types declared in the AccessStateDiff message type.

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.

BindingExplanation.Types

Container for nested types declared in the BindingExplanation message type.

BindingExplanation.Types.AnnotatedMembership

Details about whether the binding includes the principal.

CreateOrgPolicyViolationsPreviewOperationMetadata

CreateOrgPolicyViolationsPreviewOperationMetadata is metadata about an OrgPolicyViolationsPreview generations operation.

CreateOrgPolicyViolationsPreviewRequest

CreateOrgPolicyViolationsPreviewRequest is the request message for [OrgPolicyViolationsPreviewService.CreateOrgPolicyViolationsPreview][google.cloud.policysimulator.v1.OrgPolicyViolationsPreviewService.CreateOrgPolicyViolationsPreview].

CreateReplayRequest

Request message for [Simulator.CreateReplay][google.cloud.policysimulator.v1.Simulator.CreateReplay].

ExplainedAccess

Details about how a set of policies, listed in [ExplainedPolicy][google.cloud.policysimulator.v1.ExplainedPolicy], resulted in a certain [AccessState][google.cloud.policysimulator.v1.AccessState] when replaying an access tuple.

ExplainedPolicy

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

FolderLocationName

Resource name for the FolderLocation resource.

GetOrgPolicyViolationsPreviewRequest

GetOrgPolicyViolationsPreviewRequest is the request message for [OrgPolicyViolationsPreviewService.GetOrgPolicyViolationsPreview][google.cloud.policysimulator.v1.OrgPolicyViolationsPreviewService.GetOrgPolicyViolationsPreview].

GetReplayRequest

Request message for [Simulator.GetReplay][google.cloud.policysimulator.v1.Simulator.GetReplay].

ListOrgPolicyViolationsPreviewsRequest

ListOrgPolicyViolationsPreviewsRequest is the request message for [OrgPolicyViolationsPreviewService.ListOrgPolicyViolationsPreviews][google.cloud.policysimulator.v1.OrgPolicyViolationsPreviewService.ListOrgPolicyViolationsPreviews].

ListOrgPolicyViolationsPreviewsResponse

ListOrgPolicyViolationsPreviewsResponse is the response message for [OrgPolicyViolationsPreviewService.ListOrgPolicyViolationsPreviews][google.cloud.policysimulator.v1.OrgPolicyViolationsPreviewService.ListOrgPolicyViolationsPreviews].

ListOrgPolicyViolationsRequest

ListOrgPolicyViolationsRequest is the request message for [OrgPolicyViolationsPreviewService.ListOrgPolicyViolations][google.cloud.policysimulator.v1.OrgPolicyViolationsPreviewService.ListOrgPolicyViolations].

ListOrgPolicyViolationsResponse

ListOrgPolicyViolationsResponse is the response message for [OrgPolicyViolationsPreviewService.ListOrgPolicyViolations][google.cloud.policysimulator.v1.OrgPolicyViolationsPreviewService.ListOrgPolicyViolations]

ListReplayResultsRequest

Request message for [Simulator.ListReplayResults][google.cloud.policysimulator.v1.Simulator.ListReplayResults].

ListReplayResultsResponse

Response message for [Simulator.ListReplayResults][google.cloud.policysimulator.v1.Simulator.ListReplayResults].

OrgPolicyOverlay

The proposed changes to OrgPolicy.

OrgPolicyOverlay.Types

Container for nested types declared in the OrgPolicyOverlay message type.

OrgPolicyOverlay.Types.CustomConstraintOverlay

A change to an OrgPolicy custom constraint.

OrgPolicyOverlay.Types.PolicyOverlay

A change to an OrgPolicy.

OrgPolicyViolation

OrgPolicyViolation is a resource representing a single resource violating a single OrgPolicy constraint.

OrgPolicyViolationName

Resource name for the OrgPolicyViolation resource.

OrgPolicyViolationsPreview

OrgPolicyViolationsPreview is a resource providing a preview of the violations that will exist if an OrgPolicy change is made.

The list of violations are modeled as child resources and retrieved via a [ListOrgPolicyViolations][] API call. There are potentially more [OrgPolicyViolations][] than could fit in an embedded field. Thus, the use of a child resource instead of a field.

OrgPolicyViolationsPreview.Types

Container for nested types declared in the OrgPolicyViolationsPreview message type.

OrgPolicyViolationsPreview.Types.ResourceCounts

A summary of the state of all resources scanned for compliance with the changed OrgPolicy.

OrgPolicyViolationsPreviewName

Resource name for the OrgPolicyViolationsPreview resource.

OrgPolicyViolationsPreviewService

Violations Preview API service for OrgPolicy.

An [OrgPolicyViolationsPreview][google.cloud.policysimulator.v1.OrgPolicyViolationsPreview] is a preview of the violations that will exist as soon as a proposed OrgPolicy change is submitted. To create an [OrgPolicyViolationsPreview][google.cloud.policysimulator.v1.OrgPolicyViolationsPreview], the API user specifies the changes they wish to make and requests the generation of a preview via [GenerateViolationsPreview][]. the OrgPolicy Simulator service then scans the API user's currently existing resources to determine these resources violate the newly set OrgPolicy.

OrgPolicyViolationsPreviewService.OrgPolicyViolationsPreviewServiceBase

Base class for server-side implementations of OrgPolicyViolationsPreviewService

OrgPolicyViolationsPreviewService.OrgPolicyViolationsPreviewServiceClient

Client for OrgPolicyViolationsPreviewService

OrgPolicyViolationsPreviewServiceClient

OrgPolicyViolationsPreviewService client wrapper, for convenient use.

OrgPolicyViolationsPreviewServiceClientBuilder

Builder class for OrgPolicyViolationsPreviewServiceClient to provide simple configuration of credentials, endpoint etc.

OrgPolicyViolationsPreviewServiceClientImpl

OrgPolicyViolationsPreviewService client wrapper implementation, for convenient use.

OrgPolicyViolationsPreviewServiceSettings

Settings for OrgPolicyViolationsPreviewServiceClient instances.

OrganizationLocationName

Resource name for the OrganizationLocation resource.

Replay

A resource describing a Replay, or simulation.

Replay.Types

Container for nested types declared in the Replay message type.

Replay.Types.ResultsSummary

Summary statistics about the replayed log entries.

ReplayConfig

The configuration used for a [Replay][google.cloud.policysimulator.v1.Replay].

ReplayConfig.Types

Container for nested types declared in the ReplayConfig message type.

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.

ReplayName

Resource name for the Replay resource.

ReplayOperationMetadata

Metadata about a Replay operation.

ReplayResult

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

ReplayResultName

Resource name for the ReplayResult resource.

ResourceContext

ResourceContext provides the context we know about a resource. It is similar in concept to google.cloud.asset.v1.Resource, but focuses on the information specifically used by Simulator.

Simulator

Policy Simulator API service.

Policy Simulator is a collection of endpoints for creating, running, and viewing a [Replay][google.cloud.policysimulator.v1.Replay]. A [Replay][google.cloud.policysimulator.v1.Replay] is a type of simulation that lets you see how your principals' access to resources might change if you changed your IAM policy.

During a [Replay][google.cloud.policysimulator.v1.Replay], Policy Simulator re-evaluates, or replays, past access attempts under both the current policy and your proposed policy, and compares those results to determine how your principals' access might change under the proposed policy.

Simulator.SimulatorBase

Base class for server-side implementations of Simulator

Simulator.SimulatorClient

Client for Simulator

SimulatorClient

Simulator client wrapper, for convenient use.

SimulatorClientBuilder

Builder class for SimulatorClient to provide simple configuration of credentials, endpoint etc.

SimulatorClientImpl

Simulator client wrapper implementation, for convenient use.

SimulatorSettings

Settings for SimulatorClient instances.

Enums

AccessState

Whether a principal has a permission for a resource.

AccessStateDiff.Types.AccessChangeType

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

BindingExplanation.Types.Membership

Whether the binding includes the principal.

BindingExplanation.Types.RolePermission

Whether a role includes a specific permission.

FolderLocationName.ResourceNameType

The possible contents of FolderLocationName.

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.

OrgPolicyViolationName.ResourceNameType

The possible contents of OrgPolicyViolationName.

OrgPolicyViolationsPreviewName.ResourceNameType

The possible contents of OrgPolicyViolationsPreviewName.

OrganizationLocationName.ResourceNameType

The possible contents of OrganizationLocationName.

PreviewState

The current state of an [OrgPolicyViolationsPreview][google.cloud.policysimulator.v1.OrgPolicyViolationsPreview].

Replay.Types.State

The current state of the [Replay][google.cloud.policysimulator.v1.Replay].

ReplayConfig.Types.LogSource

The source of the logs to use for a [Replay][google.cloud.policysimulator.v1.Replay].

ReplayName.ResourceNameType

The possible contents of ReplayName.

ReplayResult.ResultOneofCase

Enum of possible cases for the "result" oneof.

ReplayResultName.ResourceNameType

The possible contents of ReplayResultName.