Files
google-apis-rs/google_iam1_cli/projects_roles-delete/index.html
2024-03-05 21:06:01 +01:00

424 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-iam1-cli/projects_roles-delete/" />
<link rel="shortcut icon" href="../img/favicon.ico" />
<title>Roles Delete - Iam v5.0.4+20240220</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 = "Roles Delete";
var mkdocs_page_input_path = "projects_roles-delete.md";
var mkdocs_page_url = "/google-apis-rs/google-iam1-cli/projects_roles-delete/";
</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"> Iam v5.0.4+20240220
</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">Iam Policies</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../iam-policies_lint-policy/">Lint Policy</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../iam-policies_query-auditable-services/">Query Auditable Services</a>
</li>
</ul>
<p class="caption"><span class="caption-text">Locations</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../locations_workforce-pools-create/">Workforce Pools Create</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../locations_workforce-pools-delete/">Workforce Pools Delete</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../locations_workforce-pools-get/">Workforce Pools Get</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../locations_workforce-pools-get-iam-policy/">Workforce Pools Get Iam Policy</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../locations_workforce-pools-list/">Workforce Pools List</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../locations_workforce-pools-operations-get/">Workforce Pools Operations Get</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../locations_workforce-pools-patch/">Workforce Pools Patch</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../locations_workforce-pools-providers-create/">Workforce Pools Providers Create</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../locations_workforce-pools-providers-delete/">Workforce Pools Providers Delete</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../locations_workforce-pools-providers-get/">Workforce Pools Providers Get</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../locations_workforce-pools-providers-keys-create/">Workforce Pools Providers Keys Create</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../locations_workforce-pools-providers-keys-delete/">Workforce Pools Providers Keys Delete</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../locations_workforce-pools-providers-keys-get/">Workforce Pools Providers Keys Get</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../locations_workforce-pools-providers-keys-list/">Workforce Pools Providers Keys List</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../locations_workforce-pools-providers-keys-operations-get/">Workforce Pools Providers Keys Operations Get</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../locations_workforce-pools-providers-keys-undelete/">Workforce Pools Providers Keys Undelete</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../locations_workforce-pools-providers-list/">Workforce Pools Providers List</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../locations_workforce-pools-providers-operations-get/">Workforce Pools Providers Operations Get</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../locations_workforce-pools-providers-patch/">Workforce Pools Providers Patch</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../locations_workforce-pools-providers-undelete/">Workforce Pools Providers Undelete</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../locations_workforce-pools-set-iam-policy/">Workforce Pools Set Iam Policy</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../locations_workforce-pools-subjects-delete/">Workforce Pools Subjects Delete</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../locations_workforce-pools-subjects-operations-get/">Workforce Pools Subjects Operations Get</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../locations_workforce-pools-subjects-undelete/">Workforce Pools Subjects Undelete</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../locations_workforce-pools-test-iam-permissions/">Workforce Pools Test Iam Permissions</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../locations_workforce-pools-undelete/">Workforce Pools Undelete</a>
</li>
</ul>
<p class="caption"><span class="caption-text">Organizations</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../organizations_roles-create/">Roles Create</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../organizations_roles-delete/">Roles Delete</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../organizations_roles-get/">Roles Get</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../organizations_roles-list/">Roles List</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../organizations_roles-patch/">Roles Patch</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../organizations_roles-undelete/">Roles Undelete</a>
</li>
</ul>
<p class="caption"><span class="caption-text">Permissions</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../permissions_query-testable-permissions/">Query Testable Permissions</a>
</li>
</ul>
<p class="caption"><span class="caption-text">Projects</span></p>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-workload-identity-pools-create/">Locations Workload Identity Pools Create</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-workload-identity-pools-delete/">Locations Workload Identity Pools Delete</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-workload-identity-pools-get/">Locations Workload Identity Pools Get</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-workload-identity-pools-list/">Locations Workload Identity Pools List</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-workload-identity-pools-namespaces-managed-identities-operations-get/">Locations Workload Identity Pools Namespaces Managed Identities Operations Get</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-workload-identity-pools-namespaces-managed-identities-workload-sources-operations-get/">Locations Workload Identity Pools Namespaces Managed Identities Workload Sources Operations Get</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-workload-identity-pools-namespaces-operations-get/">Locations Workload Identity Pools Namespaces Operations Get</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-workload-identity-pools-operations-get/">Locations Workload Identity Pools Operations Get</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-workload-identity-pools-patch/">Locations Workload Identity Pools Patch</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-workload-identity-pools-providers-create/">Locations Workload Identity Pools Providers Create</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-workload-identity-pools-providers-delete/">Locations Workload Identity Pools Providers Delete</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-workload-identity-pools-providers-get/">Locations Workload Identity Pools Providers Get</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-workload-identity-pools-providers-keys-create/">Locations Workload Identity Pools Providers Keys Create</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-workload-identity-pools-providers-keys-delete/">Locations Workload Identity Pools Providers Keys Delete</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-workload-identity-pools-providers-keys-get/">Locations Workload Identity Pools Providers Keys Get</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-workload-identity-pools-providers-keys-list/">Locations Workload Identity Pools Providers Keys List</a>
</li>
<li class="toctree-l1"><a class="reference internal" 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="reference internal" href="../projects_locations-workload-identity-pools-providers-keys-undelete/">Locations Workload Identity Pools Providers Keys Undelete</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-workload-identity-pools-providers-list/">Locations Workload Identity Pools Providers List</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-workload-identity-pools-providers-operations-get/">Locations Workload Identity Pools Providers Operations Get</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-workload-identity-pools-providers-patch/">Locations Workload Identity Pools Providers Patch</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-workload-identity-pools-providers-undelete/">Locations Workload Identity Pools Providers Undelete</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-workload-identity-pools-undelete/">Locations Workload Identity Pools Undelete</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_roles-create/">Roles Create</a>
</li>
<li class="toctree-l1 current"><a class="reference internal current" href="./">Roles Delete</a>
<ul class="current">
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_roles-get/">Roles Get</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_roles-list/">Roles List</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_roles-patch/">Roles Patch</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_roles-undelete/">Roles Undelete</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_service-accounts-create/">Service Accounts Create</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_service-accounts-delete/">Service Accounts Delete</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_service-accounts-disable/">Service Accounts Disable</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_service-accounts-enable/">Service Accounts Enable</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_service-accounts-get/">Service Accounts Get</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_service-accounts-get-iam-policy/">Service Accounts Get Iam Policy</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_service-accounts-keys-create/">Service Accounts Keys Create</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_service-accounts-keys-delete/">Service Accounts Keys Delete</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_service-accounts-keys-disable/">Service Accounts Keys Disable</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_service-accounts-keys-enable/">Service Accounts Keys Enable</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_service-accounts-keys-get/">Service Accounts Keys Get</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_service-accounts-keys-list/">Service Accounts Keys List</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_service-accounts-keys-upload/">Service Accounts Keys Upload</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_service-accounts-list/">Service Accounts List</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_service-accounts-patch/">Service Accounts Patch</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_service-accounts-set-iam-policy/">Service Accounts Set Iam Policy</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_service-accounts-sign-blob/">Service Accounts Sign Blob</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_service-accounts-sign-jwt/">Service Accounts Sign Jwt</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_service-accounts-test-iam-permissions/">Service Accounts Test Iam Permissions</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_service-accounts-undelete/">Service Accounts Undelete</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_service-accounts-update/">Service Accounts Update</a>
</li>
</ul>
<p class="caption"><span class="caption-text">Roles</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../roles_get/">Get</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../roles_list/">List</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../roles_query-grantable-roles/">Query Grantable Roles</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="..">Iam v5.0.4+20240220</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>Projects &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/edit/master/docs/projects_roles-delete.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>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-create/" class="btn btn-neutral float-left" title="Roles Create"><span class="icon icon-circle-arrow-left"></span> Previous</a>
<a href="../projects_roles-get/" class="btn btn-neutral float-right" title="Roles Get">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/iam1-cli" class="fa fa-github" style="color: #fcfcfc"> GitHub</a>
</span>
<span><a href="../projects_roles-create/" style="color: #fcfcfc">&laquo; Previous</a></span>
<span><a href="../projects_roles-get/" 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>