OMGeeky/google-apis-rs
1
0
Fork 0
mirror of https://github.com/OMGeeky/google-apis-rs.git synced 2026-01-27 04:10:02 +01:00
Code Issues Packages Projects Releases Wiki Activity
Files
a20241b2412723b0062d1c19a8ec792837b145a4
google-apis-rs/google_iam1_cli/projects_roles-delete/index.html
Sebastian Thiel a20241b241 Update documentation
2022-03-08 15:36:16 +08:00

563 lines
22 KiB
HTML
Raw Blame History

<!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Roles Delete - Iam v3.0.0+20220224</title>
<link href='https://fonts.googleapis.com/css?family=Lato:400,700|Roboto+Slab:400,700|Inconsolata:400,700' rel='stylesheet' type='text/css'>
<link rel="stylesheet" href="../css/theme.css" type="text/css" />
<link rel="stylesheet" href="../css/theme_extra.css" type="text/css" />
<link rel="stylesheet" href="../css/highlight.css">
<script src="//cdnjs.cloudflare.com/ajax/libs/jquery/2.1.1/jquery.min.js"></script>
<script src="//cdnjs.cloudflare.com/ajax/libs/modernizr/2.8.3/modernizr.min.js"></script>
<script type="text/javascript" src="../js/highlight.pack.js"></script>
<script src="../js/theme.js"></script>
<style>
body {font-size: 90%;}
pre, code {font-size: 100%;}
h3, h4, h5, h6 {color: #2980b9; font-weight: 300}
</style>
</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-nav-search">
<a href=".." class="icon icon-home"> Iam v3.0.0+20220224</a>
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
<ul class="current">
<span>Iam Policies</span>
<li class="toctree-l1 ">
<a class="" href="../iam-policies_lint-policy">Lint Policy</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../iam-policies_query-auditable-services">Query Auditable Services</a>
</li>
<span>Locations</span>
<li class="toctree-l1 ">
<a class="" href="../locations_workforce-pools-operations-get">Workforce Pools Operations Get</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../locations_workforce-pools-providers-operations-get">Workforce Pools Providers Operations Get</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../locations_workforce-pools-subjects-operations-get">Workforce Pools Subjects Operations Get</a>
</li>
<span>Organizations</span>
<li class="toctree-l1 ">
<a class="" href="../organizations_roles-create">Roles Create</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../organizations_roles-delete">Roles Delete</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../organizations_roles-get">Roles Get</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../organizations_roles-list">Roles List</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../organizations_roles-patch">Roles Patch</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../organizations_roles-undelete">Roles Undelete</a>
</li>
<span>Permissions</span>
<li class="toctree-l1 ">
<a class="" href="../permissions_query-testable-permissions">Query Testable Permissions</a>
</li>
<span>Projects</span>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-workload-identity-pools-create">Locations Workload Identity Pools Create</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-workload-identity-pools-delete">Locations Workload Identity Pools Delete</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-workload-identity-pools-get">Locations Workload Identity Pools Get</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-workload-identity-pools-list">Locations Workload Identity Pools List</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-workload-identity-pools-operations-get">Locations Workload Identity Pools Operations Get</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-workload-identity-pools-patch">Locations Workload Identity Pools Patch</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-workload-identity-pools-providers-create">Locations Workload Identity Pools Providers Create</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-workload-identity-pools-providers-delete">Locations Workload Identity Pools Providers Delete</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-workload-identity-pools-providers-get">Locations Workload Identity Pools Providers Get</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-workload-identity-pools-providers-keys-operations-get">Locations Workload Identity Pools Providers Keys Operations Get</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-workload-identity-pools-providers-list">Locations Workload Identity Pools Providers List</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-workload-identity-pools-providers-operations-get">Locations Workload Identity Pools Providers Operations Get</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-workload-identity-pools-providers-patch">Locations Workload Identity Pools Providers Patch</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-workload-identity-pools-providers-undelete">Locations Workload Identity Pools Providers Undelete</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-workload-identity-pools-undelete">Locations Workload Identity Pools Undelete</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_roles-create">Roles Create</a>
</li>
<li class="toctree-l1 current">
<a class="current" href=".">Roles Delete</a>
<ul>
<li class="toctree-l2"><a href="#scopes">Scopes</a></li>
<li class="toctree-l2"><a href="#required-scalar-argument">Required Scalar Argument</a></li>
<li class="toctree-l2"><a href="#optional-output-flags">Optional Output Flags</a></li>
<li class="toctree-l2"><a href="#optional-method-properties">Optional Method Properties</a></li>
<li class="toctree-l2"><a href="#optional-general-properties">Optional General Properties</a></li>
</ul>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_roles-get">Roles Get</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_roles-list">Roles List</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_roles-patch">Roles Patch</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_roles-undelete">Roles Undelete</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_service-accounts-create">Service Accounts Create</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_service-accounts-delete">Service Accounts Delete</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_service-accounts-disable">Service Accounts Disable</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_service-accounts-enable">Service Accounts Enable</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_service-accounts-get">Service Accounts Get</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_service-accounts-get-iam-policy">Service Accounts Get Iam Policy</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_service-accounts-keys-create">Service Accounts Keys Create</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_service-accounts-keys-delete">Service Accounts Keys Delete</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_service-accounts-keys-disable">Service Accounts Keys Disable</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_service-accounts-keys-enable">Service Accounts Keys Enable</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_service-accounts-keys-get">Service Accounts Keys Get</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_service-accounts-keys-list">Service Accounts Keys List</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_service-accounts-keys-upload">Service Accounts Keys Upload</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_service-accounts-list">Service Accounts List</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_service-accounts-patch">Service Accounts Patch</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_service-accounts-set-iam-policy">Service Accounts Set Iam Policy</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_service-accounts-sign-blob">Service Accounts Sign Blob</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_service-accounts-sign-jwt">Service Accounts Sign Jwt</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_service-accounts-test-iam-permissions">Service Accounts Test Iam Permissions</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_service-accounts-undelete">Service Accounts Undelete</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_service-accounts-update">Service Accounts Update</a>
</li>
<span>Roles</span>
<li class="toctree-l1 ">
<a class="" href="../roles_get">Get</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../roles_list">List</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../roles_query-grantable-roles">Query Grantable Roles</a>
</li>
</ul>
</div>
&nbsp;
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" role="navigation" aria-label="top navigation">
<i data-toggle="wy-nav-top" class="icon icon-reorder"></i>
<a href=".."></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="..">Docs</a> &raquo;</li>
<li>Roles Delete</li>
<li class="wy-breadcrumbs-aside">
<a href="https://github.com/Byron/google-apis-rs/tree/main/gen/iam1-cli" class="icon icon-github"> Edit on GitHub</a>
</li>
</ul>
<hr/>
</div>
<div role="main">
<div class="section">
<p>Deletes a custom Role. When you delete a custom role, the following changes occur immediately: * You cannot bind a principal to the custom role in an IAM Policy. * Existing bindings to the custom role are not changed, but they have no effect. * By default, the response from ListRoles does not include the custom role. You have 7 days to undelete the custom role. After 7 days, the following changes occur: * The custom role is permanently deleted and cannot be recovered. * If an IAM policy contains a binding to the custom role, the binding is permanently removed.</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>iam1 --scope &lt;scope&gt; projects roles-delete ...</code></p>
<h1 id="required-scalar-argument">Required Scalar Argument</h1>
<ul>
<li><strong>&lt;name&gt;</strong> <em>(string)</em><ul>
<li>The <code>name</code> parameter&#39;s value depends on the target resource for the request, namely <a href="https://cloud.google.com/iam/reference/rest/v1/projects.roles"><code>projects</code></a> or <a href="https://cloud.google.com/iam/reference/rest/v1/organizations.roles"><code>organizations</code></a>. Each resource type&#39;s <code>name</code> value format is described below: * <a href="https://cloud.google.com/iam/reference/rest/v1/projects.roles/delete"><code>projects.roles.delete()</code></a>: <code>projects/{PROJECT_ID}/roles/{CUSTOM_ROLE_ID}</code>. This method deletes only <a href="https://cloud.google.com/iam/docs/understanding-custom-roles">custom roles</a> that have been created at the project level. Example request URL: <code>https://iam.googleapis.com/v1/projects/{PROJECT_ID}/roles/{CUSTOM_ROLE_ID}</code> * <a href="https://cloud.google.com/iam/reference/rest/v1/organizations.roles/delete"><code>organizations.roles.delete()</code></a>: <code>organizations/{ORGANIZATION_ID}/roles/{CUSTOM_ROLE_ID}</code>. This method deletes only <a href="https://cloud.google.com/iam/docs/understanding-custom-roles">custom roles</a> that have been created at the organization level. Example request URL: <code>https://iam.googleapis.com/v1/organizations/{ORGANIZATION_ID}/roles/{CUSTOM_ROLE_ID}</code> Note: Wildcard (*) values are invalid; you must specify a complete project ID or organization ID.</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><strong>-p etag=string</strong><ul>
<li>Used to perform a consistent read-modify-write.</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="../projects_roles-get" class="btn btn-neutral float-right" title="Roles Get"/>Next <span class="icon icon-circle-arrow-right"></span></a>
<a href="../projects_roles-create" class="btn btn-neutral" title="Roles Create"><span class="icon icon-circle-arrow-left"></span> Previous</a>
</div>
<hr/>
<div role="contentinfo">
<p>
<!-- Copyright etc -->
</p>
</div>
Built with <a href="http://www.mkdocs.org">MkDocs</a>, using a <a href="https://github.com/snide/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" style="cursor: pointer">
<span class="rst-current-version" data-toggle="rst-current-version">
<a class="icon icon-github" style="float: left; color: #fcfcfc"> GitHub</a>
<span><a href="../projects_roles-create" style="color: #fcfcfc;">&laquo; Previous</a></span>
<span style="margin-left: 15px"><a href="../projects_roles-get" style="color: #fcfcfc">Next &raquo;</a></span>
</span>
</div>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink