OMGeeky/google-apis-rs
1
0
Fork 0
mirror of https://github.com/OMGeeky/google-apis-rs.git synced 2026-01-25 12:44:07 +01:00
Code Issues Packages Projects Releases Wiki Activity
Files
a20241b2412723b0062d1c19a8ec792837b145a4
google-apis-rs/google_cloudidentity1_cli/groups_list/index.html
Sebastian Thiel a20241b241 Update documentation
2022-03-08 15:36:16 +08:00

449 lines
16 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>List - Cloud Identity v3.0.0+20220301</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"> Cloud Identity v3.0.0+20220301</a>
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
<ul class="current">
<span>Devices</span>
<li class="toctree-l1 ">
<a class="" href="../devices_cancel-wipe">Cancel Wipe</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../devices_create">Create</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../devices_delete">Delete</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../devices_device-users-approve">Device Users Approve</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../devices_device-users-block">Device Users Block</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../devices_device-users-cancel-wipe">Device Users Cancel Wipe</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../devices_device-users-client-states-get">Device Users Client States Get</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../devices_device-users-client-states-list">Device Users Client States List</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../devices_device-users-client-states-patch">Device Users Client States Patch</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../devices_device-users-delete">Device Users Delete</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../devices_device-users-get">Device Users Get</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../devices_device-users-list">Device Users List</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../devices_device-users-lookup">Device Users Lookup</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../devices_device-users-wipe">Device Users Wipe</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../devices_get">Get</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../devices_list">List</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../devices_wipe">Wipe</a>
</li>
<span>Groups</span>
<li class="toctree-l1 ">
<a class="" href="../groups_create">Create</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../groups_delete">Delete</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../groups_get">Get</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../groups_get-security-settings">Get Security Settings</a>
</li>
<li class="toctree-l1 current">
<a class="current" href=".">List</a>
<ul>
<li class="toctree-l2"><a href="#scopes">Scopes</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="../groups_lookup">Lookup</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../groups_memberships-check-transitive-membership">Memberships Check Transitive Membership</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../groups_memberships-create">Memberships Create</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../groups_memberships-delete">Memberships Delete</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../groups_memberships-get">Memberships Get</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../groups_memberships-get-membership-graph">Memberships Get Membership Graph</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../groups_memberships-list">Memberships List</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../groups_memberships-lookup">Memberships Lookup</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../groups_memberships-modify-membership-roles">Memberships Modify Membership Roles</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../groups_memberships-search-transitive-groups">Memberships Search Transitive Groups</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../groups_memberships-search-transitive-memberships">Memberships Search Transitive Memberships</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../groups_patch">Patch</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../groups_search">Search</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../groups_update-security-settings">Update Security Settings</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>List</li>
<li class="wy-breadcrumbs-aside">
<a href="https://github.com/Byron/google-apis-rs/tree/main/gen/cloudidentity1-cli" class="icon icon-github"> Edit on GitHub</a>
</li>
</ul>
<hr/>
</div>
<div role="main">
<div class="section">
<p>Lists the <code>Group</code> resources under a customer or namespace.</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/cloud-identity.groups</em></li>
<li><em>https://www.googleapis.com/auth/cloud-identity.groups.readonly</em></li>
<li><em>https://www.googleapis.com/auth/cloud-platform</em></li>
</ul>
<p>If unset, the scope for this method defaults to <em>https://www.googleapis.com/auth/cloud-identity.groups.readonly</em>.
You can set the scope for this method like this: <code>cloudidentity1 --scope &lt;scope&gt; groups list ...</code></p>
<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 page-size=integer</strong></p>
<ul>
<li>The maximum number of results to return. Note that the number of results returned may be less than this value even if there are more available results. To fetch all results, clients must continue calling this method repeatedly until the response no longer contains a <code>next_page_token</code>. If unspecified, defaults to 200 for <code>View.BASIC</code> and to 50 for <code>View.FULL</code>. Must not be greater than 1000 for <code>View.BASIC</code> or 500 for <code>View.FULL</code>.</li>
</ul>
</li>
<li>
<p><strong>-p page-token=string</strong></p>
<ul>
<li>The <code>next_page_token</code> value returned from a previous list request, if any.</li>
</ul>
</li>
<li>
<p><strong>-p parent=string</strong></p>
<ul>
<li>Required. The parent resource under which to list all <code>Group</code> resources. Must be of the form <code>identitysources/{identity_source}</code> for external- identity-mapped groups or <code>customers/{customer}</code> for Google Groups. The <code>customer</code> must begin with &#34;C&#34; (for example, &#39;C046psxkn&#39;).</li>
</ul>
</li>
<li>
<p><strong>-p view=string</strong></p>
<ul>
<li>The level of detail to be returned. If unspecified, defaults to <code>View.BASIC</code>.</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="../groups_lookup" class="btn btn-neutral float-right" title="Lookup"/>Next <span class="icon icon-circle-arrow-right"></span></a>
<a href="../groups_get-security-settings" class="btn btn-neutral" title="Get Security Settings"><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="../groups_get-security-settings" style="color: #fcfcfc;">&laquo; Previous</a></span>
<span style="margin-left: 15px"><a href="../groups_lookup" style="color: #fcfcfc">Next &raquo;</a></span>
</span>
</div>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink