mirror of
https://github.com/OMGeeky/google-apis-rs.git
synced 2026-02-01 14:54:02 +01:00
370 lines
20 KiB
HTML
370 lines
20 KiB
HTML
<!DOCTYPE html>
|
|
<html class="writer-html5" lang="en" >
|
|
<head>
|
|
<meta charset="utf-8" />
|
|
<meta http-equiv="X-UA-Compatible" content="IE=edge" />
|
|
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><link rel="canonical" href="http://byron.github.io/google-apis-rs/google-cloudasset1-cli/methods_analyze-iam-policy/" />
|
|
<link rel="shortcut icon" href="../img/favicon.ico" />
|
|
<title>Analyze Iam Policy - Cloud Asset v5.0.4+20240302</title>
|
|
<link rel="stylesheet" href="../css/theme.css" />
|
|
<link rel="stylesheet" href="../css/theme_extra.css" />
|
|
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.5.0/styles/github.min.css" />
|
|
|
|
<script>
|
|
// Current page data
|
|
var mkdocs_page_name = "Analyze Iam Policy";
|
|
var mkdocs_page_input_path = "methods_analyze-iam-policy.md";
|
|
var mkdocs_page_url = "/google-apis-rs/google-cloudasset1-cli/methods_analyze-iam-policy/";
|
|
</script>
|
|
|
|
<script src="../js/jquery-3.6.0.min.js" defer></script>
|
|
<!--[if lt IE 9]>
|
|
<script src="../js/html5shiv.min.js"></script>
|
|
<![endif]-->
|
|
<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.5.0/highlight.min.js"></script>
|
|
<script>hljs.initHighlightingOnLoad();</script>
|
|
</head>
|
|
|
|
<body class="wy-body-for-nav" role="document">
|
|
|
|
<div class="wy-grid-for-nav">
|
|
<nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav">
|
|
<div class="wy-side-scroll">
|
|
<div class="wy-side-nav-search">
|
|
<a href=".." class="icon icon-home"> Cloud Asset v5.0.4+20240302
|
|
</a><div role="search">
|
|
<form id ="rtd-search-form" class="wy-form" action="../search.html" method="get">
|
|
<input type="text" name="q" placeholder="Search docs" title="Type search term here" />
|
|
</form>
|
|
</div>
|
|
</div>
|
|
|
|
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
|
|
<ul>
|
|
<li class="toctree-l1"><a class="reference internal" href="..">Home</a>
|
|
</li>
|
|
</ul>
|
|
<p class="caption"><span class="caption-text">Assets</span></p>
|
|
<ul>
|
|
<li class="toctree-l1"><a class="reference internal" href="../assets_list/">List</a>
|
|
</li>
|
|
</ul>
|
|
<p class="caption"><span class="caption-text">Effective Iam Policies</span></p>
|
|
<ul>
|
|
<li class="toctree-l1"><a class="reference internal" href="../effective-iam-policies_batch-get/">Batch Get</a>
|
|
</li>
|
|
</ul>
|
|
<p class="caption"><span class="caption-text">Feeds</span></p>
|
|
<ul>
|
|
<li class="toctree-l1"><a class="reference internal" href="../feeds_create/">Create</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../feeds_delete/">Delete</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../feeds_get/">Get</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../feeds_list/">List</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../feeds_patch/">Patch</a>
|
|
</li>
|
|
</ul>
|
|
<p class="caption"><span class="caption-text">Methods</span></p>
|
|
<ul class="current">
|
|
<li class="toctree-l1 current"><a class="reference internal current" href="./">Analyze Iam Policy</a>
|
|
<ul class="current">
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../methods_analyze-iam-policy-longrunning/">Analyze Iam Policy Longrunning</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../methods_analyze-move/">Analyze Move</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../methods_analyze-org-policies/">Analyze Org Policies</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../methods_analyze-org-policy-governed-assets/">Analyze Org Policy Governed Assets</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../methods_analyze-org-policy-governed-containers/">Analyze Org Policy Governed Containers</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../methods_batch-get-assets-history/">Batch Get Assets History</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../methods_export-assets/">Export Assets</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../methods_query-assets/">Query Assets</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../methods_search-all-iam-policies/">Search All Iam Policies</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../methods_search-all-resources/">Search All Resources</a>
|
|
</li>
|
|
</ul>
|
|
<p class="caption"><span class="caption-text">Operations</span></p>
|
|
<ul>
|
|
<li class="toctree-l1"><a class="reference internal" href="../operations_get/">Get</a>
|
|
</li>
|
|
</ul>
|
|
<p class="caption"><span class="caption-text">Saved Queries</span></p>
|
|
<ul>
|
|
<li class="toctree-l1"><a class="reference internal" href="../saved-queries_create/">Create</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../saved-queries_delete/">Delete</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../saved-queries_get/">Get</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../saved-queries_list/">List</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../saved-queries_patch/">Patch</a>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</nav>
|
|
|
|
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
|
|
<nav class="wy-nav-top" role="navigation" aria-label="Mobile navigation menu">
|
|
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
|
|
<a href="..">Cloud Asset v5.0.4+20240302</a>
|
|
|
|
</nav>
|
|
<div class="wy-nav-content">
|
|
<div class="rst-content"><div role="navigation" aria-label="breadcrumbs navigation">
|
|
<ul class="wy-breadcrumbs">
|
|
<li><a href=".." class="icon icon-home" alt="Docs"></a> »</li>
|
|
<li>Methods »</li>
|
|
<li>Analyze Iam Policy</li>
|
|
<li class="wy-breadcrumbs-aside">
|
|
<a href="https://github.com/Byron/google-apis-rs/tree/main/gen/cloudasset1-cli/edit/master/docs/methods_analyze-iam-policy.md"
|
|
class="icon icon-github"> Edit on GitHub</a>
|
|
</li>
|
|
</ul>
|
|
<hr/>
|
|
</div>
|
|
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
|
|
<div class="section" itemprop="articleBody">
|
|
|
|
<p>Analyzes IAM policies to answer which identities have what accesses on which resources.</p>
|
|
<h1 id="scopes">Scopes</h1>
|
|
<p>You will need authorization for the <em>https://www.googleapis.com/auth/cloud-platform</em> scope to make a valid call.</p>
|
|
<p>If unset, the scope for this method defaults to <em>https://www.googleapis.com/auth/cloud-platform</em>.
|
|
You can set the scope for this method like this: <code>cloudasset1 --scope <scope> methods analyze-iam-policy ...</code></p>
|
|
<h1 id="required-scalar-argument">Required Scalar Argument</h1>
|
|
<ul>
|
|
<li><strong><scope></strong> <em>(string)</em><ul>
|
|
<li>Required. The relative name of the root asset. Only resources and IAM policies within the scope 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 <a href="https://cloud.google.com/resource-manager/docs/creating-managing-organization#retrieving_your_organization_id">here </a>. To know how to get folder or project ID, visit <a href="https://cloud.google.com/resource-manager/docs/creating-managing-folders#viewing_or_listing_folders_and_projects">here </a>.</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
<h1 id="optional-output-flags">Optional Output Flags</h1>
|
|
<p>The method's return value a JSON encoded structure, which will be written to standard output by default.</p>
|
|
<ul>
|
|
<li><strong>-o out</strong><ul>
|
|
<li><em>out</em> specifies the <em>destination</em> to which to write the server's result to.
|
|
It will be a JSON-encoded structure.
|
|
The <em>destination</em> may be <code>-</code> to indicate standard output, or a filepath that is to contain the received bytes.
|
|
If unset, it defaults to standard output.</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
<h1 id="optional-method-properties">Optional Method Properties</h1>
|
|
<p>You may set the following properties to further configure the call. Please note that <code>-p</code> is followed by one
|
|
or more key-value-pairs, and is called like this <code>-p k1=v1 k2=v2</code> even though the listing below repeats the
|
|
<code>-p</code> for completeness.</p>
|
|
<ul>
|
|
<li>
|
|
<p><strong>-p analysis-query-access-selector-permissions=string</strong></p>
|
|
<ul>
|
|
<li>Optional. The permissions to appear in result.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><strong>-p analysis-query-access-selector-roles=string</strong></p>
|
|
<ul>
|
|
<li>Optional. The roles to appear in result.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><strong>-p analysis-query-condition-context-access-time=string</strong></p>
|
|
<ul>
|
|
<li>The hypothetical access timestamp to evaluate IAM conditions. Note that this value must not be earlier than the current time; otherwise, an INVALID_ARGUMENT error will be returned.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><strong>-p analysis-query-identity-selector-identity=string</strong></p>
|
|
<ul>
|
|
<li>Required. The identity appear in the form of principals in <a href="https://cloud.google.com/iam/reference/rest/v1/Binding">IAM policy binding</a>. 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.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><strong>-p analysis-query-options-analyze-service-account-impersonation=boolean</strong></p>
|
|
<ul>
|
|
<li>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 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 Google Cloud folder F, then user A potentially has access to the Google Cloud 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 Google Cloud 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 Google Cloud folder F, then user A potentially has access to the Google Cloud folder F. And those advanced analysis results will be included in AnalyzeIamPolicyResponse.service_account_impersonation_analysis. Only the following permissions are considered in this analysis: * <code>iam.serviceAccounts.actAs</code> * <code>iam.serviceAccounts.signBlob</code> * <code>iam.serviceAccounts.signJwt</code> * <code>iam.serviceAccounts.getAccessToken</code> * <code>iam.serviceAccounts.getOpenIdToken</code> * <code>iam.serviceAccounts.implicitDelegation</code> Default is false.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><strong>-p analysis-query-options-expand-groups=boolean</strong></p>
|
|
<ul>
|
|
<li>Optional. If true, the identities section of the result will expand any Google groups appearing in an IAM policy binding. If 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.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><strong>-p analysis-query-options-expand-resources=boolean</strong></p>
|
|
<ul>
|
|
<li>Optional. If true and 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 Google Cloud folder, the results will also include resources in that folder with permission P. If true and 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 resources cannot be used together with this option. For example, if the request analyzes for which users have permission P on a Google Cloud 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.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><strong>-p analysis-query-options-expand-roles=boolean</strong></p>
|
|
<ul>
|
|
<li>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 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.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><strong>-p analysis-query-options-output-group-edges=boolean</strong></p>
|
|
<ul>
|
|
<li>Optional. If true, the result will output the relevant membership relationships between groups and other groups, and between groups and principals. Default is false.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><strong>-p analysis-query-options-output-resource-edges=boolean</strong></p>
|
|
<ul>
|
|
<li>Optional. If true, the result will output the relevant parent/child relationships between resources. Default is false.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><strong>-p analysis-query-resource-selector-full-resource-name=string</strong></p>
|
|
<ul>
|
|
<li>Required. The [full resource name] (https://cloud.google.com/asset-inventory/docs/resource-name-format) of a resource of <a href="https://cloud.google.com/asset-inventory/docs/supported-asset-types#analyzable_asset_types">supported resource types</a>.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><strong>-p execution-timeout=string</strong></p>
|
|
<ul>
|
|
<li>Optional. Amount of time executable has to complete. See JSON representation of <a href="https://developers.google.com/protocol-buffers/docs/proto3#json">Duration</a>. 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.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><strong>-p saved-analysis-query=string</strong></p>
|
|
<ul>
|
|
<li>Optional. The name of a saved query, which must be in the format of: * projects/project_number/savedQueries/saved_query_id * folders/folder_number/savedQueries/saved_query_id * organizations/organization_number/savedQueries/saved_query_id If both <code>analysis_query</code> and <code>saved_analysis_query</code> are provided, they will be merged together with the <code>saved_analysis_query</code> as base and the <code>analysis_query</code> as overrides. For more details of the merge behavior, refer to the <a href="https://developers.google.com/protocol-buffers/docs/reference/cpp/google.protobuf.message#Message.MergeFrom.details">MergeFrom</a> page. Note that you cannot override primitive fields with default value, such as 0 or empty string, etc., because we use proto3, which doesn't support field presence yet.</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
<h1 id="optional-general-properties">Optional General Properties</h1>
|
|
<p>The following properties can configure any call, and are not specific to this method.</p>
|
|
<ul>
|
|
<li>
|
|
<p><strong>-p $-xgafv=string</strong></p>
|
|
<ul>
|
|
<li>V1 error format.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><strong>-p access-token=string</strong></p>
|
|
<ul>
|
|
<li>OAuth access token.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><strong>-p alt=string</strong></p>
|
|
<ul>
|
|
<li>Data format for response.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><strong>-p callback=string</strong></p>
|
|
<ul>
|
|
<li>JSONP</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><strong>-p fields=string</strong></p>
|
|
<ul>
|
|
<li>Selector specifying which fields to include in a partial response.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><strong>-p key=string</strong></p>
|
|
<ul>
|
|
<li>API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><strong>-p oauth-token=string</strong></p>
|
|
<ul>
|
|
<li>OAuth 2.0 token for the current user.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><strong>-p pretty-print=boolean</strong></p>
|
|
<ul>
|
|
<li>Returns response with indentations and line breaks.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><strong>-p quota-user=string</strong></p>
|
|
<ul>
|
|
<li>Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><strong>-p upload-type=string</strong></p>
|
|
<ul>
|
|
<li>Legacy upload protocol for media (e.g. "media", "multipart").</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><strong>-p upload-protocol=string</strong></p>
|
|
<ul>
|
|
<li>Upload protocol for media (e.g. "raw", "multipart").</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
|
|
</div>
|
|
</div><footer>
|
|
<div class="rst-footer-buttons" role="navigation" aria-label="Footer Navigation">
|
|
<a href="../feeds_patch/" class="btn btn-neutral float-left" title="Patch"><span class="icon icon-circle-arrow-left"></span> Previous</a>
|
|
<a href="../methods_analyze-iam-policy-longrunning/" class="btn btn-neutral float-right" title="Analyze Iam Policy Longrunning">Next <span class="icon icon-circle-arrow-right"></span></a>
|
|
</div>
|
|
|
|
<hr/>
|
|
|
|
<div role="contentinfo">
|
|
<!-- Copyright etc -->
|
|
<p>Copyright © 2015-2020, `Sebastian Thiel`</p>
|
|
</div>
|
|
|
|
Built with <a href="https://www.mkdocs.org/">MkDocs</a> using a <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
|
</footer>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
</section>
|
|
|
|
</div>
|
|
|
|
<div class="rst-versions" role="note" aria-label="Versions">
|
|
<span class="rst-current-version" data-toggle="rst-current-version">
|
|
|
|
<span>
|
|
<a href="https://github.com/Byron/google-apis-rs/tree/main/gen/cloudasset1-cli" class="fa fa-github" style="color: #fcfcfc"> GitHub</a>
|
|
</span>
|
|
|
|
|
|
<span><a href="../feeds_patch/" style="color: #fcfcfc">« Previous</a></span>
|
|
|
|
|
|
<span><a href="../methods_analyze-iam-policy-longrunning/" style="color: #fcfcfc">Next »</a></span>
|
|
|
|
</span>
|
|
</div>
|
|
<script>var base_url = '..';</script>
|
|
<script src="../js/theme_extra.js" defer></script>
|
|
<script src="../js/theme.js" defer></script>
|
|
<script src="../search/main.js" defer></script>
|
|
<script defer>
|
|
window.onload = function () {
|
|
SphinxRtdTheme.Navigation.enable(true);
|
|
};
|
|
</script>
|
|
|
|
</body>
|
|
</html>
|