mirror of
https://github.com/OMGeeky/google-apis-rs.git
synced 2026-01-28 04:41:02 +01:00
409 lines
20 KiB
HTML
409 lines
20 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-cloudidentity1-cli/groups_memberships-create/" />
|
|
<link rel="shortcut icon" href="../img/favicon.ico" />
|
|
<title>Memberships Create - Cloud Identity 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 = "Memberships Create";
|
|
var mkdocs_page_input_path = "groups_memberships-create.md";
|
|
var mkdocs_page_url = "/google-apis-rs/google-cloudidentity1-cli/groups_memberships-create/";
|
|
</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"> Cloud Identity 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">Customers</span></p>
|
|
<ul>
|
|
<li class="toctree-l1"><a class="reference internal" href="../customers_userinvitations-cancel/">Userinvitations Cancel</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../customers_userinvitations-get/">Userinvitations Get</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../customers_userinvitations-is-invitable-user/">Userinvitations Is Invitable User</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../customers_userinvitations-list/">Userinvitations List</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../customers_userinvitations-send/">Userinvitations Send</a>
|
|
</li>
|
|
</ul>
|
|
<p class="caption"><span class="caption-text">Devices</span></p>
|
|
<ul>
|
|
<li class="toctree-l1"><a class="reference internal" href="../devices_cancel-wipe/">Cancel Wipe</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../devices_create/">Create</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../devices_delete/">Delete</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../devices_device-users-approve/">Device Users Approve</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../devices_device-users-block/">Device Users Block</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../devices_device-users-cancel-wipe/">Device Users Cancel Wipe</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../devices_device-users-client-states-get/">Device Users Client States Get</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../devices_device-users-client-states-list/">Device Users Client States List</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../devices_device-users-client-states-patch/">Device Users Client States Patch</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../devices_device-users-delete/">Device Users Delete</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../devices_device-users-get/">Device Users Get</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../devices_device-users-list/">Device Users List</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../devices_device-users-lookup/">Device Users Lookup</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../devices_device-users-wipe/">Device Users Wipe</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../devices_get/">Get</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../devices_list/">List</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../devices_wipe/">Wipe</a>
|
|
</li>
|
|
</ul>
|
|
<p class="caption"><span class="caption-text">Groups</span></p>
|
|
<ul class="current">
|
|
<li class="toctree-l1"><a class="reference internal" href="../groups_create/">Create</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../groups_delete/">Delete</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../groups_get/">Get</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../groups_get-security-settings/">Get Security Settings</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../groups_list/">List</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../groups_lookup/">Lookup</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../groups_memberships-check-transitive-membership/">Memberships Check Transitive Membership</a>
|
|
</li>
|
|
<li class="toctree-l1 current"><a class="reference internal current" href="./">Memberships Create</a>
|
|
<ul class="current">
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../groups_memberships-delete/">Memberships Delete</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../groups_memberships-get/">Memberships Get</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../groups_memberships-get-membership-graph/">Memberships Get Membership Graph</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../groups_memberships-list/">Memberships List</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../groups_memberships-lookup/">Memberships Lookup</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../groups_memberships-modify-membership-roles/">Memberships Modify Membership Roles</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../groups_memberships-search-direct-groups/">Memberships Search Direct Groups</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../groups_memberships-search-transitive-groups/">Memberships Search Transitive Groups</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../groups_memberships-search-transitive-memberships/">Memberships Search Transitive Memberships</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../groups_patch/">Patch</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../groups_search/">Search</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../groups_update-security-settings/">Update Security Settings</a>
|
|
</li>
|
|
</ul>
|
|
<p class="caption"><span class="caption-text">Inbound Saml Sso Profiles</span></p>
|
|
<ul>
|
|
<li class="toctree-l1"><a class="reference internal" href="../inbound-saml-sso-profiles_create/">Create</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../inbound-saml-sso-profiles_delete/">Delete</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../inbound-saml-sso-profiles_get/">Get</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../inbound-saml-sso-profiles_idp-credentials-add/">Idp Credentials Add</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../inbound-saml-sso-profiles_idp-credentials-delete/">Idp Credentials Delete</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../inbound-saml-sso-profiles_idp-credentials-get/">Idp Credentials Get</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../inbound-saml-sso-profiles_idp-credentials-list/">Idp Credentials List</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../inbound-saml-sso-profiles_list/">List</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../inbound-saml-sso-profiles_patch/">Patch</a>
|
|
</li>
|
|
</ul>
|
|
<p class="caption"><span class="caption-text">Inbound Sso Assignments</span></p>
|
|
<ul>
|
|
<li class="toctree-l1"><a class="reference internal" href="../inbound-sso-assignments_create/">Create</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../inbound-sso-assignments_delete/">Delete</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../inbound-sso-assignments_get/">Get</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../inbound-sso-assignments_list/">List</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../inbound-sso-assignments_patch/">Patch</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="..">Cloud Identity 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> »</li>
|
|
<li>Groups »</li>
|
|
<li>Memberships Create</li>
|
|
<li class="wy-breadcrumbs-aside">
|
|
<a href="https://github.com/Byron/google-apis-rs/tree/main/gen/cloudidentity1-cli/edit/master/docs/groups_memberships-create.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>Creates a <code>Membership</code>.</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-platform</em></li>
|
|
</ul>
|
|
<p>If unset, the scope for this method defaults to <em>https://www.googleapis.com/auth/cloud-identity.groups</em>.
|
|
You can set the scope for this method like this: <code>cloudidentity1 --scope <scope> groups memberships-create ...</code></p>
|
|
<h1 id="required-scalar-argument">Required Scalar Argument</h1>
|
|
<ul>
|
|
<li><strong><parent></strong> <em>(string)</em><ul>
|
|
<li>Required. The parent <code>Group</code> resource under which to create the <code>Membership</code>. Must be of the form <code>groups/{group}</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>Membership:
|
|
create-time: string
|
|
delivery-setting: string
|
|
name: string
|
|
preferred-member-key:
|
|
id: string
|
|
namespace: string
|
|
type: string
|
|
update-time: 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><code>-r . create-time=accusam</code><ul>
|
|
<li>Output only. The time when the <code>Membership</code> was created.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>delivery-setting=takimata</code><ul>
|
|
<li>Output only. Delivery setting associated with the membership.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>name=consetetur</code><ul>
|
|
<li>Output only. The <a href="https://cloud.google.com/apis/design/resource_names">resource name</a> of the <code>Membership</code>. Shall be of the form <code>groups/{group}/memberships/{membership}</code>.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>preferred-member-key id=voluptua.</code><ul>
|
|
<li>The ID of the entity. For Google-managed entities, the <code>id</code> should be the email address of an existing group or user. Email addresses need to adhere to <a href="https://support.google.com/a/answer/9193374">name guidelines for users and groups</a>. For external-identity-mapped entities, the <code>id</code> must be a string conforming to the Identity Source's requirements. Must be unique within a <code>namespace</code>.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>namespace=et</code></p>
|
|
<ul>
|
|
<li>The namespace in which the entity exists. If not specified, the <code>EntityKey</code> represents a Google-managed entity such as a Google user or a Google Group. If specified, the <code>EntityKey</code> represents an external-identity-mapped group. The namespace must correspond to an identity source created in Admin Console and must be in the form of <code>identitysources/{identity_source}</code>.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>.. type=erat</code></p>
|
|
<ul>
|
|
<li>Output only. The type of the membership.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>update-time=consetetur</code><ul>
|
|
<li>Output only. The time when the <code>Membership</code> was last updated.</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-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. "media", "multipart").</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><strong>-p upload-protocol=string</strong></p>
|
|
<ul>
|
|
<li>Upload protocol for media (e.g. "raw", "multipart").</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
|
|
</div>
|
|
</div><footer>
|
|
<div class="rst-footer-buttons" role="navigation" aria-label="Footer Navigation">
|
|
<a href="../groups_memberships-check-transitive-membership/" class="btn btn-neutral float-left" title="Memberships Check Transitive Membership"><span class="icon icon-circle-arrow-left"></span> Previous</a>
|
|
<a href="../groups_memberships-delete/" class="btn btn-neutral float-right" title="Memberships Delete">Next <span class="icon icon-circle-arrow-right"></span></a>
|
|
</div>
|
|
|
|
<hr/>
|
|
|
|
<div role="contentinfo">
|
|
<!-- Copyright etc -->
|
|
<p>Copyright © 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/cloudidentity1-cli" class="fa fa-github" style="color: #fcfcfc"> GitHub</a>
|
|
</span>
|
|
|
|
|
|
<span><a href="../groups_memberships-check-transitive-membership/" style="color: #fcfcfc">« Previous</a></span>
|
|
|
|
|
|
<span><a href="../groups_memberships-delete/" style="color: #fcfcfc">Next »</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>
|