Files
2024-03-05 21:06:01 +01:00

389 lines
19 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-accesscontextmanager1-cli/access-policies_access-levels-patch/" />
<link rel="shortcut icon" href="../img/favicon.ico" />
<title>Access Levels Patch - Access Context Manager v5.0.4+20240226</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 = "Access Levels Patch";
var mkdocs_page_input_path = "access-policies_access-levels-patch.md";
var mkdocs_page_url = "/google-apis-rs/google-accesscontextmanager1-cli/access-policies_access-levels-patch/";
</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"> Access Context Manager v5.0.4+20240226
</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">Access Policies</span></p>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="../access-policies_access-levels-create/">Access Levels Create</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../access-policies_access-levels-delete/">Access Levels Delete</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../access-policies_access-levels-get/">Access Levels Get</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../access-policies_access-levels-list/">Access Levels List</a>
</li>
<li class="toctree-l1 current"><a class="reference internal current" href="./">Access Levels Patch</a>
<ul class="current">
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../access-policies_access-levels-replace-all/">Access Levels Replace All</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../access-policies_access-levels-test-iam-permissions/">Access Levels Test Iam Permissions</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../access-policies_authorized-orgs-descs-create/">Authorized Orgs Descs Create</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../access-policies_authorized-orgs-descs-delete/">Authorized Orgs Descs Delete</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../access-policies_authorized-orgs-descs-get/">Authorized Orgs Descs Get</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../access-policies_authorized-orgs-descs-list/">Authorized Orgs Descs List</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../access-policies_authorized-orgs-descs-patch/">Authorized Orgs Descs Patch</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../access-policies_create/">Create</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../access-policies_delete/">Delete</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../access-policies_get/">Get</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../access-policies_get-iam-policy/">Get Iam Policy</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../access-policies_list/">List</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../access-policies_patch/">Patch</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../access-policies_service-perimeters-commit/">Service Perimeters Commit</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../access-policies_service-perimeters-create/">Service Perimeters Create</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../access-policies_service-perimeters-delete/">Service Perimeters Delete</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../access-policies_service-perimeters-get/">Service Perimeters Get</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../access-policies_service-perimeters-list/">Service Perimeters List</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../access-policies_service-perimeters-patch/">Service Perimeters Patch</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../access-policies_service-perimeters-replace-all/">Service Perimeters Replace All</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../access-policies_service-perimeters-test-iam-permissions/">Service Perimeters Test Iam Permissions</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../access-policies_set-iam-policy/">Set Iam Policy</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../access-policies_test-iam-permissions/">Test Iam Permissions</a>
</li>
</ul>
<p class="caption"><span class="caption-text">Operations</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../operations_cancel/">Cancel</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../operations_delete/">Delete</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../operations_get/">Get</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../operations_list/">List</a>
</li>
</ul>
<p class="caption"><span class="caption-text">Organizations</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../organizations_gcp-user-access-bindings-create/">Gcp User Access Bindings Create</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../organizations_gcp-user-access-bindings-delete/">Gcp User Access Bindings Delete</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../organizations_gcp-user-access-bindings-get/">Gcp User Access Bindings Get</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../organizations_gcp-user-access-bindings-list/">Gcp User Access Bindings List</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../organizations_gcp-user-access-bindings-patch/">Gcp User Access Bindings Patch</a>
</li>
</ul>
<p class="caption"><span class="caption-text">Services</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../services_get/">Get</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../services_list/">List</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="..">Access Context Manager v5.0.4+20240226</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> &raquo;</li>
<li>Access Policies &raquo;</li>
<li>Access Levels Patch</li>
<li class="wy-breadcrumbs-aside">
<a href="https://github.com/Byron/google-apis-rs/tree/main/gen/accesscontextmanager1-cli/edit/master/docs/access-policies_access-levels-patch.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>Updates an access level. The long-running operation from this RPC has a successful status after the changes to the access level propagate to long-lasting storage. If access levels contain errors, an error response is returned for the first error encountered.</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>accesscontextmanager1 --scope &lt;scope&gt; access-policies access-levels-patch ...</code></p>
<h1 id="required-scalar-argument">Required Scalar Argument</h1>
<ul>
<li><strong>&lt;name&gt;</strong> <em>(string)</em><ul>
<li>Resource name for the <code>AccessLevel</code>. Format: <code>accessPolicies/{access_policy}/accessLevels/{access_level}</code>. The <code>access_level</code> component must begin with a letter, followed by alphanumeric characters or <code>_</code>. Its maximum length is 50 characters. After you create an <code>AccessLevel</code>, you cannot change its <code>name</code>.</li>
</ul>
</li>
</ul>
<h1 id="required-request-value">Required Request Value</h1>
<p>The request value is a data-structure with various fields. Each field may be a simple scalar or another data-structure.
In the latter case it is advised to set the field-cursor to the data-structure's field to specify values more concisely.</p>
<p>For example, a structure like this:</p>
<pre><code>AccessLevel:
basic:
combining-function: string
custom:
expr:
description: string
expression: string
location: string
title: string
description: string
name: string
title: string
</code></pre>
<p>can be set completely with the following arguments which are assumed to be executed in the given order. Note how the cursor position is adjusted to the respective structures, allowing simple field names to be used most of the time.</p>
<ul>
<li>
<p><code>-r .basic combining-function=amet.</code></p>
<ul>
<li>How the <code>conditions</code> list should be combined to determine if a request is granted this <code>AccessLevel</code>. If AND is used, each <code>Condition</code> in <code>conditions</code> must be satisfied for the <code>AccessLevel</code> to be applied. If OR is used, at least one <code>Condition</code> in <code>conditions</code> must be satisfied for the <code>AccessLevel</code> to be applied. Default behavior is AND.</li>
</ul>
</li>
<li>
<p><code>..custom.expr description=takimata</code></p>
<ul>
<li>Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.</li>
</ul>
</li>
<li><code>expression=amet.</code><ul>
<li>Textual representation of an expression in Common Expression Language syntax.</li>
</ul>
</li>
<li><code>location=duo</code><ul>
<li>Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.</li>
</ul>
</li>
<li>
<p><code>title=ipsum</code></p>
<ul>
<li>Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.</li>
</ul>
</li>
<li>
<p><code>... description=gubergren</code></p>
<ul>
<li>Description of the <code>AccessLevel</code> and its use. Does not affect behavior.</li>
</ul>
</li>
<li><code>name=lorem</code><ul>
<li>Resource name for the <code>AccessLevel</code>. Format: <code>accessPolicies/{access_policy}/accessLevels/{access_level}</code>. The <code>access_level</code> component must begin with a letter, followed by alphanumeric characters or <code>_</code>. Its maximum length is 50 characters. After you create an <code>AccessLevel</code>, you cannot change its <code>name</code>.</li>
</ul>
</li>
<li><code>title=gubergren</code><ul>
<li>Human readable title. Must be unique within the Policy.</li>
</ul>
</li>
</ul>
<h3 id="about-cursors">About Cursors</h3>
<p>The cursor position is key to comfortably set complex nested structures. The following rules apply:</p>
<ul>
<li>The cursor position is always set relative to the current one, unless the field name starts with the <code>.</code> character. Fields can be nested such as in <code>-r f.s.o</code> .</li>
<li>The cursor position is set relative to the top-level structure if it starts with <code>.</code>, e.g. <code>-r .s.s</code></li>
<li>You can also set nested fields without setting the cursor explicitly. For example, to set a value relative to the current cursor position, you would specify <code>-r struct.sub_struct=bar</code>.</li>
<li>You can move the cursor one level up by using <code>..</code>. Each additional <code>.</code> moves it up one additional level. E.g. <code>...</code> would go three levels up.</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><strong>-p update-mask=string</strong><ul>
<li>Required. Mask to control which fields get updated. Must be non-empty.</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. &#34;media&#34;, &#34;multipart&#34;).</li>
</ul>
</li>
<li>
<p><strong>-p upload-protocol=string</strong></p>
<ul>
<li>Upload protocol for media (e.g. &#34;raw&#34;, &#34;multipart&#34;).</li>
</ul>
</li>
</ul>
</div>
</div><footer>
<div class="rst-footer-buttons" role="navigation" aria-label="Footer Navigation">
<a href="../access-policies_access-levels-list/" class="btn btn-neutral float-left" title="Access Levels List"><span class="icon icon-circle-arrow-left"></span> Previous</a>
<a href="../access-policies_access-levels-replace-all/" class="btn btn-neutral float-right" title="Access Levels Replace All">Next <span class="icon icon-circle-arrow-right"></span></a>
</div>
<hr/>
<div role="contentinfo">
<!-- Copyright etc -->
<p>Copyright &copy; 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/accesscontextmanager1-cli" class="fa fa-github" style="color: #fcfcfc"> GitHub</a>
</span>
<span><a href="../access-policies_access-levels-list/" style="color: #fcfcfc">&laquo; Previous</a></span>
<span><a href="../access-policies_access-levels-replace-all/" style="color: #fcfcfc">Next &raquo;</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>