Google Cloud Asset Inventory v1 API - Class IamPolicyAnalysisQuery.Types.Options (3.2.0)

public sealed class Options : IMessage<IamPolicyAnalysisQuery.Types.Options>, IEquatable<IamPolicyAnalysisQuery.Types.Options>, IDeepCloneable<IamPolicyAnalysisQuery.Types.Options>, IBufferMessage, IMessage

Reference documentation and code samples for the Google Cloud Asset Inventory v1 API class IamPolicyAnalysisQuery.Types.Options.

Contains query options.

Inheritance

Object > IamPolicyAnalysisQuery.Types.Options

Namespace

Google.Cloud.Asset.V1

Assembly

Google.Cloud.Asset.V1.dll

Constructors

Options()

public Options()

Options(IamPolicyAnalysisQuery.Types.Options)

public Options(IamPolicyAnalysisQuery.Types.Options other)
Parameter
NameDescription
otherIamPolicyAnalysisQuery.Types.Options

Properties

AnalyzeServiceAccountImpersonation

public bool AnalyzeServiceAccountImpersonation { get; set; }

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.AnalyzeIamPolicyLongrunning][google.cloud.asset.v1.AssetService.AnalyzeIamPolicyLongrunning] 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][google.cloud.asset.v1.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][google.cloud.asset.v1.AnalyzeIamPolicyResponse.service_account_impersonation_analysis].

Only the following permissions are considered in this analysis:

  • iam.serviceAccounts.actAs
  • iam.serviceAccounts.signBlob
  • iam.serviceAccounts.signJwt
  • iam.serviceAccounts.getAccessToken
  • iam.serviceAccounts.getOpenIdToken
  • iam.serviceAccounts.implicitDelegation

Default is false.

Property Value
TypeDescription
Boolean

ExpandGroups

public bool ExpandGroups { get; set; }

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

If [IamPolicyAnalysisQuery.identity_selector][google.cloud.asset.v1.IamPolicyAnalysisQuery.identity_selector] is specified, the identity in the result will be determined by the selector, and this flag is not allowed to set.

If true, the default max expansion per group is 1000 for AssetService.AnalyzeIamPolicy][].

Default is false.

Property Value
TypeDescription
Boolean

ExpandResources

public bool ExpandResources { get; set; }

Optional. If true and [IamPolicyAnalysisQuery.resource_selector][google.cloud.asset.v1.IamPolicyAnalysisQuery.resource_selector] is not specified, 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 true and [IamPolicyAnalysisQuery.resource_selector][google.cloud.asset.v1.IamPolicyAnalysisQuery.resource_selector] is specified, the resource section of the result will expand the specified resource to include resources lower in the resource hierarchy. Only project or lower resources are supported. Folder and organization resource cannot be used together with this option.

For example, if the request analyzes for which users have permission P on a GCP project with this option enabled, the results will include all users who have permission P on that project or any lower resource.

If true, the default max expansion per resource is 1000 for AssetService.AnalyzeIamPolicy][] and 100000 for AssetService.AnalyzeIamPolicyLongrunning][].

Default is false.

Property Value
TypeDescription
Boolean

ExpandRoles

public bool ExpandRoles { get; set; }

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

If [IamPolicyAnalysisQuery.access_selector][google.cloud.asset.v1.IamPolicyAnalysisQuery.access_selector] is specified, the access section of the result will be determined by the selector, and this flag is not allowed to set.

Default is false.

Property Value
TypeDescription
Boolean

OutputGroupEdges

public bool OutputGroupEdges { get; set; }

Optional. If true, the result will output the relevant membership relationships between groups and other groups, and between groups and principals. Default is false.

Property Value
TypeDescription
Boolean

OutputResourceEdges

public bool OutputResourceEdges { get; set; }

Optional. If true, the result will output the relevant parent/child relationships between resources. Default is false.

Property Value
TypeDescription
Boolean