Method: analyzeIamPolicy

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

HTTP request

GET https://cloudasset.googleapis.com/v1p4beta1/{analysisQuery.parent=*/*}:analyzeIamPolicy

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
analysisQuery.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

Query parameters

Parameters
analysisQuery.resourceSelector

object (ResourceSelector)

Optional. Specifies a resource for analysis.

analysisQuery.identitySelector

object (IdentitySelector)

Optional. Specifies an identity for analysis.

analysisQuery.accessSelector

object (AccessSelector)

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

options

object (Options)

Optional. The request options.

Request body

The request body must be empty.

Response body

If successful, the response body contains data with the following structure:

A response message for AssetService.AnalyzeIamPolicy.

JSON representation
{
  "mainAnalysis": {
    object (IamPolicyAnalysis)
  },
  "serviceAccountImpersonationAnalysis": [
    {
      object (IamPolicyAnalysis)
    }
  ],
  "fullyExplored": boolean,
  "nonCriticalErrors": [
    {
      object (AnalysisState)
    }
  ]
}
Fields
mainAnalysis

object (IamPolicyAnalysis)

The main analysis that matches the original request.

serviceAccountImpersonationAnalysis[]

object (IamPolicyAnalysis)

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

fullyExplored

boolean

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

nonCriticalErrors[]

object (AnalysisState)

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

Authorization Scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview.

Options

Contains request options.

JSON representation
{
  "expandGroups": boolean,
  "expandRoles": boolean,
  "expandResources": boolean,
  "outputResourceEdges": boolean,
  "outputGroupEdges": boolean,
  "analyzeServiceAccountImpersonation": boolean,
  "executionTimeout": string
}
Fields
expandGroups

boolean

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

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

Default is false.

expandRoles

boolean

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

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

Default is false.

expandResources

boolean

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 [resourceSelector][] is specified, the resource section of the result will be determined by the selector, and this flag will have no effect. Default is false.

outputResourceEdges

boolean

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

outputGroupEdges

boolean

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

analyzeServiceAccountImpersonation

boolean

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.

executionTimeout

string (Duration format)

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.

A duration in seconds with up to nine fractional digits, terminated by 's'. Example: "3.5s".

IamPolicyAnalysis

An analysis message to group the query and results.

JSON representation
{
  "analysisQuery": {
    object (IamPolicyAnalysisQuery)
  },
  "analysisResults": [
    {
      object (IamPolicyAnalysisResult)
    }
  ],
  "fullyExplored": boolean
}
Fields
analysisQuery

object (IamPolicyAnalysisQuery)

The analysis query.

analysisResults[]

object (IamPolicyAnalysisResult)

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

fullyExplored

boolean

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

IamPolicyAnalysisResult

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

JSON representation
{
  "attachedResourceFullName": string,
  "iamBinding": {
    object (Binding)
  },
  "accessControlLists": [
    {
      object (AccessControlList)
    }
  ],
  "identityList": {
    object (IdentityList)
  },
  "fullyExplored": boolean
}
Fields
attachedResourceFullName

string

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

iamBinding

object (Binding)

The Cloud IAM policy binding under analysis.

accessControlLists[]

object (AccessControlList)

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

identityList

object (IdentityList)

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

fullyExplored

boolean

Represents whether all analyses on the iamBinding have successfully finished.

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]

JSON representation
{
  "resources": [
    {
      object (Resource)
    }
  ],
  "accesses": [
    {
      object (Access)
    }
  ],
  "resourceEdges": [
    {
      object (Edge)
    }
  ]
}
Fields
resources[]

object (Resource)

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

accesses[]

object (Access)

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

resourceEdges[]

object (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 outputResourceEdges option is enabled in request.

Resource

A Google Cloud resource under analysis.

JSON representation
{
  "fullResourceName": string,
  "analysisState": {
    object (AnalysisState)
  }
}
Fields
fullResourceName

string

The full resource name

analysisState

object (AnalysisState)

The analysis state of this resource.

AnalysisState

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

JSON representation
{
  "code": enum (Code),
  "cause": string
}
Fields
code

enum (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.

Access

An IAM role or permission under analysis.

JSON representation
{
  "analysisState": {
    object (AnalysisState)
  },

  // Union field oneof_access can be only one of the following:
  "role": string,
  "permission": string
  // End of list of possible types for union field oneof_access.
}
Fields
analysisState

object (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.

Edge

A directional edge.

JSON representation
{
  "sourceNode": string,
  "targetNode": string
}
Fields
sourceNode

string

The source node of the edge.

targetNode

string

The target node of the edge.

IdentityList

JSON representation
{
  "identities": [
    {
      object (Identity)
    }
  ],
  "groupEdges": [
    {
      object (Edge)
    }
  ]
}
Fields
identities[]

object (Identity)

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

groupEdges[]

object (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 outputGroupEdges option is enabled in request.

Identity

An identity under analysis.

JSON representation
{
  "name": string,
  "analysisState": {
    object (AnalysisState)
  }
}
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.

analysisState

object (AnalysisState)

The analysis state of this identity.