Package google.cloud.asset.v1p4beta1

Index

AssetService

Asset service definition.

AnalyzeIamPolicy

rpc AnalyzeIamPolicy(AnalyzeIamPolicyRequest) returns (AnalyzeIamPolicyResponse)

Analyzes IAM policies to answer which identities have what accesses on which resources.

Authorization Scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview.

ExportIamPolicyAnalysis

rpc ExportIamPolicyAnalysis(ExportIamPolicyAnalysisRequest) returns (Operation)

Exports the answers of which identities have what accesses on which resources to a Google Cloud Storage destination. The output format is the JSON format that represents a AnalyzeIamPolicyResponse in the JSON format. This method implements the google.longrunning.Operation, which allows you to keep track of the export. We recommend intervals of at least 2 seconds with exponential retry to poll the export operation result. The metadata contains the request to help callers to map responses to requests.

Authorization Scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview.

AnalyzeIamPolicyRequest

A request message for AssetService.AnalyzeIamPolicy.

Fields
analysis_query

IamPolicyAnalysisQuery

Required. The request query.

options

Options

Optional. The request options.

Options

Contains request options.

Fields
expand_groups

bool

Optional. If true, the identities section of the result will expand any Google groups appearing in an IAM policy binding.

If [identity_selector][] is specified, the identity in the result will be determined by the selector, and this flag will have no effect.

Default is false.

expand_roles

bool

Optional. If true, the access section of result will expand any roles appearing in IAM policy bindings to include their permissions.

If [access_selector][] is specified, the access section of the result will be determined by the selector, and this flag will have no effect.

Default is false.

expand_resources

bool

Optional. If true, the resource section of the result will expand any resource attached to an IAM policy to include resources lower in the resource hierarchy.

For example, if the request analyzes for which resources user A has permission P, and the results include an IAM policy with P on a GCP folder, the results will also include resources in that folder with permission P.

If [resource_selector][] is specified, the resource section of the result will be determined by the selector, and this flag will have no effect. Default is false.

output_resource_edges

bool

Optional. If true, the result will output resource edges, starting from the policy attached resource, to any expanded resources. Default is false.

output_group_edges

bool

Optional. If true, the result will output group identity edges, starting from the binding's group members, to any expanded identities. Default is false.

analyze_service_account_impersonation

bool

Optional. If true, the response will include access analysis from identities to resources via service account impersonation. This is a very expensive operation, because many derived queries will be executed. We highly recommend you use AssetService.ExportIamPolicyAnalysis rpc instead.

For example, if the request analyzes for which resources user A has permission P, and there's an IAM policy states user A has iam.serviceAccounts.getAccessToken permission to a service account SA, and there's another IAM policy states service account SA has permission P to a GCP folder F, then user A potentially has access to the GCP folder F. And those advanced analysis results will be included in AnalyzeIamPolicyResponse.service_account_impersonation_analysis.

Another example, if the request analyzes for who has permission P to a GCP folder F, and there's an IAM policy states user A has iam.serviceAccounts.actAs permission to a service account SA, and there's another IAM policy states service account SA has permission P to the GCP folder F, then user A potentially has access to the GCP folder F. And those advanced analysis results will be included in AnalyzeIamPolicyResponse.service_account_impersonation_analysis.

Default is false.

execution_timeout

Duration

Optional. Amount of time executable has to complete. See JSON representation of Duration.

If this field is set with a value less than the RPC deadline, and the execution of your query hasn't finished in the specified execution timeout, you will get a response with partial result. Otherwise, your query's execution will continue until the RPC deadline. If it's not finished until then, you will get a DEADLINE_EXCEEDED error.

Default is empty.

AnalyzeIamPolicyResponse

A response message for AssetService.AnalyzeIamPolicy.

Fields
main_analysis

IamPolicyAnalysis

The main analysis that matches the original request.

service_account_impersonation_analysis[]

IamPolicyAnalysis

The service account impersonation analysis if [AnalyzeIamPolicyRequest.analyze_service_account_impersonation][] is enabled.

fully_explored

bool

Represents whether all entries in the main_analysis and service_account_impersonation_analysis have been fully explored to answer the query in the request.

non_critical_errors[]

AnalysisState

A list of non-critical errors happened during the request handling to explain why fully_explored is false, or empty if no error happened.

IamPolicyAnalysis

An analysis message to group the query and results.

Fields
analysis_query

IamPolicyAnalysisQuery

The analysis query.

analysis_results[]

IamPolicyAnalysisResult

A list of IamPolicyAnalysisResult that matches the analysis query, or empty if no result is found.

fully_explored

bool

Represents whether all entries in the analysis_results have been fully explored to answer the query.

ExportIamPolicyAnalysisRequest

A request message for AssetService.ExportIamPolicyAnalysis.

Fields
analysis_query

IamPolicyAnalysisQuery

Required. The request query.

options

Options

Optional. The request options.

output_config

IamPolicyAnalysisOutputConfig

Required. Output configuration indicating where the results will be output to.

Options

Contains request options.

Fields
expand_groups

bool

Optional. If true, the identities section of the result will expand any Google groups appearing in an IAM policy binding.

If [identity_selector][] is specified, the identity in the result will be determined by the selector, and this flag will have no effect.

Default is false.

expand_roles

bool

Optional. If true, the access section of result will expand any roles appearing in IAM policy bindings to include their permissions.

If [access_selector][] is specified, the access section of the result will be determined by the selector, and this flag will have no effect.

Default is false.

expand_resources

bool

Optional. If true, the resource section of the result will expand any resource attached to an IAM policy to include resources lower in the resource hierarchy.

For example, if the request analyzes for which resources user A has permission P, and the results include an IAM policy with P on a GCP folder, the results will also include resources in that folder with permission P.

If [resource_selector][] is specified, the resource section of the result will be determined by the selector, and this flag will have no effect. Default is false.

output_resource_edges

bool

Optional. If true, the result will output resource edges, starting from the policy attached resource, to any expanded resources. Default is false.

output_group_edges

bool

Optional. If true, the result will output group identity edges, starting from the binding's group members, to any expanded identities. Default is false.

analyze_service_account_impersonation

bool

Optional. If true, the response will include access analysis from identities to resources via service account impersonation. This is a very expensive operation, because many derived queries will be executed.

For example, if the request analyzes for which resources user A has permission P, and there's an IAM policy states user A has iam.serviceAccounts.getAccessToken permission to a service account SA, and there's another IAM policy states service account SA has permission P to a GCP folder F, then user A potentially has access to the GCP folder F. And those advanced analysis results will be included in AnalyzeIamPolicyResponse.service_account_impersonation_analysis.

Another example, if the request analyzes for who has permission P to a GCP folder F, and there's an IAM policy states user A has iam.serviceAccounts.actAs permission to a service account SA, and there's another IAM policy states service account SA has permission P to the GCP folder F, then user A potentially has access to the GCP folder F. And those advanced analysis results will be included in AnalyzeIamPolicyResponse.service_account_impersonation_analysis.

Default is false.

IamPolicyAnalysisOutputConfig

Output configuration for export IAM policy analysis destination.

Fields
gcs_destination

GcsDestination

Destination on Cloud Storage.

GcsDestination

A Cloud Storage location.

Fields
uri

string

Required. The uri of the Cloud Storage object. It's the same uri that is used by gsutil. For example: "gs://bucket_name/object_name". See Viewing and Editing Object Metadata for more information.

IamPolicyAnalysisQuery

IAM policy analysis query message.

Fields
parent

string

Required. The relative name of the root asset. Only resources and IAM policies within the parent will be analyzed.

This can only be an organization number (such as "organizations/123"), a folder number (such as "folders/123"), a project ID (such as "projects/my-project-id"), or a project number (such as "projects/12345").

To know how to get organization id, visit here .

To know how to get folder or project id, visit here .

Authorization requires the following IAM permission on the specified resource parent:

  • cloudasset.assets.analyzeIamPolicy
resource_selector

ResourceSelector

Optional. Specifies a resource for analysis.

identity_selector

IdentitySelector

Optional. Specifies an identity for analysis.

access_selector

AccessSelector

Optional. Specifies roles or permissions for analysis. This is optional.

AccessSelector

Specifies roles and/or permissions to analyze, to determine both the identities possessing them and the resources they control. If multiple values are specified, results will include identities and resources matching any of them. The total number of roles and permissions should be equal or less than 10.

Fields
roles[]

string

Optional. The roles to appear in result.

permissions[]

string

Optional. The permissions to appear in result.

IdentitySelector

Specifies an identity for which to determine resource access, based on roles assigned either directly to them or to the groups they belong to, directly or indirectly.

Fields
identity

string

Required. The identity appear in the form of members in IAM policy binding.

The examples of supported forms are: "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com".

Notice that wildcard characters (such as * and ?) are not supported. You must give a specific identity.

ResourceSelector

Specifies the resource to analyze for access policies, which may be set directly on the resource, or on ancestors such as organizations, folders or projects.

Fields
full_resource_name

string

Required. The full resource name of a resource of supported resource types.

IamPolicyAnalysisResult

IAM Policy analysis result, consisting of one IAM policy binding and derived access control lists.

Fields
attached_resource_full_name

string

The full resource name of the resource to which the iam_binding policy attaches.

iam_binding

Binding

The Cloud IAM policy binding under analysis.

access_control_lists[]

AccessControlList

The access control lists derived from the iam_binding that match or potentially match resource and access selectors specified in the request.

identity_list

IdentityList

The identity list derived from members of the iam_binding that match or potentially match identity selector specified in the request.

fully_explored

bool

Represents whether all analyses on the iam_binding have successfully finished.

Access

An IAM role or permission under analysis.

Fields
analysis_state

AnalysisState

The analysis state of this access.

Union field oneof_access.

oneof_access can be only one of the following:

role

string

The role.

permission

string

The permission.

AccessControlList

An access control list, derived from the above IAM policy binding, which contains a set of resources and accesses. May include one item from each set to compose an access control entry.

NOTICE that there could be multiple access control lists for one IAM policy binding. The access control lists are created based on resource and access combinations.

For example, assume we have the following cases in one IAM policy binding: - Permission P1 and P2 apply to resource R1 and R2; - Permission P3 applies to resource R2 and R3;

This will result in the following access control lists: - AccessControlList 1: [R1, R2], [P1, P2] - AccessControlList 2: [R2, R3], [P3]

Fields
resources[]

Resource

The resources that match one of the following conditions: - The resource_selector, if it is specified in request; - Otherwise, resources reachable from the policy attached resource.

accesses[]

Access

The accesses that match one of the following conditions: - The access_selector, if it is specified in request; - Otherwise, access specifiers reachable from the policy binding's role.

resource_edges[]

Edge

Resource edges of the graph starting from the policy attached resource to any descendant resources. The Edge.source_node contains the full resource name of a parent resource and Edge.target_node contains the full resource name of a child resource. This field is present only if the output_resource_edges option is enabled in request.

AnalysisState

Represents the detailed state of an entity under analysis, such as a resource, an identity or an access.

Fields
code

Code

The Google standard error code that best describes the state. For example: - OK means the analysis on this entity has been successfully finished; - PERMISSION_DENIED means an access denied error is encountered; - DEADLINE_EXCEEDED means the analysis on this entity hasn't been started in time;

cause

string

The human-readable description of the cause of failure.

Edge

A directional edge.

Fields
source_node

string

The source node of the edge.

target_node

string

The target node of the edge.

Identity

An identity under analysis.

Fields
name

string

The identity name in any form of members appear in IAM policy binding, such as: - user:foo@google.com - group:group1@google.com - serviceAccount:s1@prj1.iam.gserviceaccount.com - projectOwner:some_project_id - domain:google.com - allUsers - etc.

analysis_state

AnalysisState

The analysis state of this identity.

IdentityList

Fields
identities[]

Identity

Only the identities that match one of the following conditions will be presented: - The identity_selector, if it is specified in request; - Otherwise, identities reachable from the policy binding's members.

group_edges[]

Edge

Group identity edges of the graph starting from the binding's group members to any node of the identities. The Edge.source_node contains a group, such as "group:parent@google.com". The Edge.target_node contains a member of the group, such as "group:child@google.com" or "user:foo@google.com". This field is present only if the output_group_edges option is enabled in request.

Resource

A Google Cloud resource under analysis.

Fields
full_resource_name

string

The full resource name

analysis_state

AnalysisState

The analysis state of this resource.