Files
google-apis-rs/google_drive2_cli/permissions_patch/index.html
2024-03-05 21:06:01 +01:00

563 lines
26 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-drive2-cli/permissions_patch/" />
<link rel="shortcut icon" href="../img/favicon.ico" />
<title>Patch - drive v5.0.4+20240227</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 = "Patch";
var mkdocs_page_input_path = "permissions_patch.md";
var mkdocs_page_url = "/google-apis-rs/google-drive2-cli/permissions_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"> drive v5.0.4+20240227
</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">About</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../about_get/">Get</a>
</li>
</ul>
<p class="caption"><span class="caption-text">Apps</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../apps_get/">Get</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../apps_list/">List</a>
</li>
</ul>
<p class="caption"><span class="caption-text">Changes</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../changes_get/">Get</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../changes_get-start-page-token/">Get Start Page Token</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../changes_list/">List</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../changes_watch/">Watch</a>
</li>
</ul>
<p class="caption"><span class="caption-text">Channels</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../channels_stop/">Stop</a>
</li>
</ul>
<p class="caption"><span class="caption-text">Children</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../children_delete/">Delete</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../children_get/">Get</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../children_insert/">Insert</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../children_list/">List</a>
</li>
</ul>
<p class="caption"><span class="caption-text">Comments</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../comments_delete/">Delete</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../comments_get/">Get</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../comments_insert/">Insert</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../comments_list/">List</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../comments_patch/">Patch</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../comments_update/">Update</a>
</li>
</ul>
<p class="caption"><span class="caption-text">Drives</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../drives_delete/">Delete</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../drives_get/">Get</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../drives_hide/">Hide</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../drives_insert/">Insert</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../drives_list/">List</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../drives_unhide/">Unhide</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../drives_update/">Update</a>
</li>
</ul>
<p class="caption"><span class="caption-text">Files</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../files_copy/">Copy</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../files_delete/">Delete</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../files_empty-trash/">Empty Trash</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../files_export/">Export</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../files_generate-ids/">Generate Ids</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../files_get/">Get</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../files_insert/">Insert</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../files_list/">List</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../files_list-labels/">List Labels</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../files_modify-labels/">Modify Labels</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../files_patch/">Patch</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../files_touch/">Touch</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../files_trash/">Trash</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../files_untrash/">Untrash</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../files_update/">Update</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../files_watch/">Watch</a>
</li>
</ul>
<p class="caption"><span class="caption-text">Parents</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../parents_delete/">Delete</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../parents_get/">Get</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../parents_insert/">Insert</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../parents_list/">List</a>
</li>
</ul>
<p class="caption"><span class="caption-text">Permissions</span></p>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="../permissions_delete/">Delete</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../permissions_get/">Get</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../permissions_get-id-for-email/">Get Id For Email</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../permissions_insert/">Insert</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../permissions_list/">List</a>
</li>
<li class="toctree-l1 current"><a class="reference internal current" href="./">Patch</a>
<ul class="current">
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../permissions_update/">Update</a>
</li>
</ul>
<p class="caption"><span class="caption-text">Properties</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../properties_delete/">Delete</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../properties_get/">Get</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../properties_insert/">Insert</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../properties_list/">List</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../properties_patch/">Patch</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../properties_update/">Update</a>
</li>
</ul>
<p class="caption"><span class="caption-text">Replies</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../replies_delete/">Delete</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../replies_get/">Get</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../replies_insert/">Insert</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../replies_list/">List</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../replies_patch/">Patch</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../replies_update/">Update</a>
</li>
</ul>
<p class="caption"><span class="caption-text">Revisions</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../revisions_delete/">Delete</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../revisions_get/">Get</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../revisions_list/">List</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../revisions_patch/">Patch</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../revisions_update/">Update</a>
</li>
</ul>
<p class="caption"><span class="caption-text">Teamdrives</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../teamdrives_delete/">Delete</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../teamdrives_get/">Get</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../teamdrives_insert/">Insert</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../teamdrives_list/">List</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../teamdrives_update/">Update</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="..">drive v5.0.4+20240227</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>Permissions &raquo;</li>
<li>Patch</li>
<li class="wy-breadcrumbs-aside">
<a href="https://github.com/Byron/google-apis-rs/tree/main/gen/drive2-cli/edit/master/docs/permissions_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 a permission using patch semantics. <strong>Warning:</strong> Concurrent permissions operations on the same file are not supported; only the last update is applied.</p>
<h1 id="scopes">Scopes</h1>
<p>You will need authorization for at least one of the following scopes to make a valid call:</p>
<ul>
<li><em>https://www.googleapis.com/auth/drive</em></li>
<li><em>https://www.googleapis.com/auth/drive.file</em></li>
</ul>
<p>If unset, the scope for this method defaults to <em>https://www.googleapis.com/auth/drive</em>.
You can set the scope for this method like this: <code>drive2 --scope &lt;scope&gt; permissions patch ...</code></p>
<h1 id="required-scalar-arguments">Required Scalar Arguments</h1>
<ul>
<li><strong>&lt;file-id&gt;</strong> <em>(string)</em><ul>
<li>The ID for the file or shared drive.</li>
</ul>
</li>
<li><strong>&lt;permission-id&gt;</strong> <em>(string)</em><ul>
<li>The ID for the permission.</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>Permission:
additional-roles: [string]
auth-key: string
deleted: boolean
domain: string
email-address: string
etag: string
expiration-date: string
id: string
kind: string
name: string
pending-owner: boolean
photo-link: string
role: string
self-link: string
type: string
value: string
view: string
with-link: boolean
</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><code>-r . additional-roles=sea</code><ul>
<li>Additional roles for this user. Only <code>commenter</code> is currently allowed, though more may be supported in the future.</li>
<li>Each invocation of this argument appends the given value to the array.</li>
</ul>
</li>
<li><code>auth-key=aliquyam</code><ul>
<li>Output only. Deprecated.</li>
</ul>
</li>
<li><code>deleted=false</code><ul>
<li>Output only. Whether the account associated with this permission has been deleted. This field only pertains to user and group permissions.</li>
</ul>
</li>
<li><code>domain=magna</code><ul>
<li>Output only. The domain name of the entity this permission refers to. This is an output-only field which is present when the permission type is <code>user</code>, <code>group</code> or <code>domain</code>.</li>
</ul>
</li>
<li><code>email-address=tempor</code><ul>
<li>Output only. The email address of the user or group this permission refers to. This is an output-only field which is present when the permission type is <code>user</code> or <code>group</code>.</li>
</ul>
</li>
<li><code>etag=dolor</code><ul>
<li>Output only. The ETag of the permission.</li>
</ul>
</li>
<li><code>expiration-date=ea</code><ul>
<li>The time at which this permission will expire (RFC 3339 date-time). Expiration dates have the following restrictions: - They can only be set on user and group permissions - The date must be in the future - The date cannot be more than a year in the future - The date can only be set on drive.permissions.update or drive.permissions.patch requests</li>
</ul>
</li>
<li><code>id=eirmod</code><ul>
<li>The ID of the user this permission refers to, and identical to the <code>permissionId</code> in the About and Files resources. When making a <code>drive.permissions.insert</code> request, exactly one of the <code>id</code> or <code>value</code> fields must be specified unless the permission type is <code>anyone</code>, in which case both <code>id</code> and <code>value</code> are ignored.</li>
</ul>
</li>
<li><code>kind=et</code><ul>
<li>Output only. This is always <code>drive#permission</code>.</li>
</ul>
</li>
<li><code>name=erat</code><ul>
<li>Output only. The name for this permission.</li>
</ul>
</li>
<li><code>pending-owner=true</code><ul>
<li>Whether the account associated with this permission is a pending owner. Only populated for <code>user</code> type permissions for files that are not in a shared drive.</li>
</ul>
</li>
<li><code>photo-link=amet</code><ul>
<li>Output only. A link to the profile photo, if available.</li>
</ul>
</li>
<li><code>role=vero</code><ul>
<li>The primary role for this user. While new values may be supported in the future, the following are currently allowed: * <code>owner</code> * <code>organizer</code> * <code>fileOrganizer</code> * <code>writer</code> * <code>reader</code></li>
</ul>
</li>
<li><code>self-link=duo</code><ul>
<li>Output only. A link back to this permission.</li>
</ul>
</li>
<li><code>type=dolor</code><ul>
<li>The account type. Allowed values are: * <code>user</code> * <code>group</code> * <code>domain</code> * <code>anyone</code></li>
</ul>
</li>
<li><code>value=est</code><ul>
<li>The email address or domain name for the entity. This is used during inserts and is not populated in responses. When making a <code>drive.permissions.insert</code> request, exactly one of the <code>id</code> or <code>value</code> fields must be specified unless the permission type is <code>anyone</code>, in which case both <code>id</code> and <code>value</code> are ignored.</li>
</ul>
</li>
<li><code>view=et</code><ul>
<li>Indicates the view for this permission. Only populated for permissions that belong to a view. <code>published</code> is the only supported value.</li>
</ul>
</li>
<li><code>with-link=true</code><ul>
<li>Whether the link is required for this permission.</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>
<p><strong>-p remove-expiration=boolean</strong></p>
<ul>
<li>Whether to remove the expiration date.</li>
</ul>
</li>
<li>
<p><strong>-p supports-all-drives=boolean</strong></p>
<ul>
<li>Whether the requesting application supports both My Drives and shared drives.</li>
</ul>
</li>
<li>
<p><strong>-p supports-team-drives=boolean</strong></p>
<ul>
<li>Deprecated: Use <code>supportsAllDrives</code> instead.</li>
</ul>
</li>
<li>
<p><strong>-p transfer-ownership=boolean</strong></p>
<ul>
<li>Whether changing a role to <code>owner</code> downgrades the current owners to writers. Does nothing if the specified role is not <code>owner</code>.</li>
</ul>
</li>
<li>
<p><strong>-p use-domain-admin-access=boolean</strong></p>
<ul>
<li>Issue the request as a domain administrator; if set to true, then the requester will be granted access if the file ID parameter refers to a shared drive and the requester is an administrator of the domain to which the shared drive belongs.</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="../permissions_list/" class="btn btn-neutral float-left" title="List"><span class="icon icon-circle-arrow-left"></span> Previous</a>
<a href="../permissions_update/" class="btn btn-neutral float-right" title="Update">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/drive2-cli" class="fa fa-github" style="color: #fcfcfc"> GitHub</a>
</span>
<span><a href="../permissions_list/" style="color: #fcfcfc">&laquo; Previous</a></span>
<span><a href="../permissions_update/" 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>