OMGeeky/google-apis-rs
1
0
Fork 0
mirror of https://github.com/OMGeeky/google-apis-rs.git synced 2026-02-23 15:49:49 +01:00
Code Issues Packages Projects Releases Wiki Activity
Files
a20241b2412723b0062d1c19a8ec792837b145a4
google-apis-rs/google_managedidentities1_cli/projects_locations-global-domains-update-ldapssettings/index.html
Sebastian Thiel a20241b241 Update documentation
2022-03-08 15:36:16 +08:00

523 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>Locations Global Domains Update Ldapssettings - Managed Service for Microsoft Active Directory Consumer API v3.0.0+20220216</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"> Managed Service for Microsoft Active Directory Consumer API v3.0.0+20220216</a>
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
<ul class="current">
<span>Projects</span>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-get">Locations Get</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-global-domains-attach-trust">Locations Global Domains Attach Trust</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-global-domains-backups-create">Locations Global Domains Backups Create</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-global-domains-backups-delete">Locations Global Domains Backups Delete</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-global-domains-backups-get">Locations Global Domains Backups Get</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-global-domains-backups-get-iam-policy">Locations Global Domains Backups Get Iam Policy</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-global-domains-backups-list">Locations Global Domains Backups List</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-global-domains-backups-patch">Locations Global Domains Backups Patch</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-global-domains-backups-set-iam-policy">Locations Global Domains Backups Set Iam Policy</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-global-domains-backups-test-iam-permissions">Locations Global Domains Backups Test Iam Permissions</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-global-domains-create">Locations Global Domains Create</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-global-domains-delete">Locations Global Domains Delete</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-global-domains-detach-trust">Locations Global Domains Detach Trust</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-global-domains-get">Locations Global Domains Get</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-global-domains-get-iam-policy">Locations Global Domains Get Iam Policy</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-global-domains-get-ldapssettings">Locations Global Domains Get Ldapssettings</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-global-domains-list">Locations Global Domains List</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-global-domains-patch">Locations Global Domains Patch</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-global-domains-reconfigure-trust">Locations Global Domains Reconfigure Trust</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-global-domains-reset-admin-password">Locations Global Domains Reset Admin Password</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-global-domains-restore">Locations Global Domains Restore</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-global-domains-set-iam-policy">Locations Global Domains Set Iam Policy</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-global-domains-sql-integrations-get">Locations Global Domains Sql Integrations Get</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-global-domains-sql-integrations-list">Locations Global Domains Sql Integrations List</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-global-domains-test-iam-permissions">Locations Global Domains Test Iam Permissions</a>
</li>
<li class="toctree-l1 current">
<a class="current" href=".">Locations Global Domains Update Ldapssettings</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="#required-request-value">Required Request Value</a></li>
<li><a class="toctree-l3" href="#about-cursors">About Cursors</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_locations-global-domains-validate-trust">Locations Global Domains Validate Trust</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-global-operations-cancel">Locations Global Operations Cancel</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-global-operations-delete">Locations Global Operations Delete</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-global-operations-get">Locations Global Operations Get</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-global-operations-list">Locations Global Operations List</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-global-peerings-create">Locations Global Peerings Create</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-global-peerings-delete">Locations Global Peerings Delete</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-global-peerings-get">Locations Global Peerings Get</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-global-peerings-get-iam-policy">Locations Global Peerings Get Iam Policy</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-global-peerings-list">Locations Global Peerings List</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-global-peerings-patch">Locations Global Peerings Patch</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-global-peerings-set-iam-policy">Locations Global Peerings Set Iam Policy</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-global-peerings-test-iam-permissions">Locations Global Peerings Test Iam Permissions</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-list">Locations List</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>Locations Global Domains Update Ldapssettings</li>
<li class="wy-breadcrumbs-aside">
<a href="https://github.com/Byron/google-apis-rs/tree/main/gen/managedidentities1-cli" class="icon icon-github"> Edit on GitHub</a>
</li>
</ul>
<hr/>
</div>
<div role="main">
<div class="section">
<p>Patches a single ldaps settings.</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>managedidentities1 --scope &lt;scope&gt; projects locations-global-domains-update-ldapssettings ...</code></p>
<h1 id="required-scalar-argument">Required Scalar Argument</h1>
<ul>
<li><strong>&lt;name&gt;</strong> <em>(string)</em><ul>
<li>The resource name of the LDAPS settings. Uses the form: <code>projects/{project}/locations/{location}/domains/{domain}</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>LDAPSSettings:
certificate:
expire-time: string
subject: string
subject-alternative-name: [string]
thumbprint: string
certificate-password: string
certificate-pfx: string
name: string
state: 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 .certificate expire-time=no</code><ul>
<li>The certificate expire time.</li>
</ul>
</li>
<li><code>subject=ipsum</code><ul>
<li>The certificate subject.</li>
</ul>
</li>
<li><code>subject-alternative-name=accusam</code><ul>
<li>The additional hostnames for the domain.</li>
<li>Each invocation of this argument appends the given value to the array.</li>
</ul>
</li>
<li>
<p><code>thumbprint=takimata</code></p>
<ul>
<li>The certificate thumbprint which uniquely identifies the certificate.</li>
</ul>
</li>
<li>
<p><code>.. certificate-password=consetetur</code></p>
<ul>
<li>Input only. The password used to encrypt the uploaded PFX certificate.</li>
</ul>
</li>
<li><code>certificate-pfx=voluptua.</code><ul>
<li>Input only. The uploaded PKCS12-formatted certificate to configure LDAPS with. It will enable the domain controllers in this domain to accept LDAPS connections (either LDAP over SSL/TLS or the StartTLS operation). A valid certificate chain must form a valid x.509 certificate chain (or be comprised of a single self-signed certificate. It must be encrypted with either: 1) PBES2 + PBKDF2 + AES256 encryption and SHA256 PRF; or 2) pbeWithSHA1And3-KeyTripleDES-CBC Private key must be included for the leaf / single self-signed certificate. Note: For a fqdn your-example-domain.com, the wildcard fqdn is *.your-example-domain.com. Specifically the leaf certificate must have: - Either a blank subject or a subject with CN matching the wildcard fqdn. - Exactly two SANs - the fqdn and wildcard fqdn. - Encipherment and digital key signature key usages. - Server authentication extended key usage (OID=1.3.6.1.5.5.7.3.1) - Private key must be in one of the following formats: RSA, ECDSA, ED25519. - Private key must have appropriate key length: 2048 for RSA, 256 for ECDSA - Signature algorithm of the leaf certificate cannot be MD2, MD5 or SHA1.</li>
</ul>
</li>
<li><code>name=et</code><ul>
<li>The resource name of the LDAPS settings. Uses the form: <code>projects/{project}/locations/{location}/domains/{domain}</code>.</li>
</ul>
</li>
<li><code>state=erat</code><ul>
<li>Output only. The current state of this LDAPS settings.</li>
</ul>
</li>
<li><code>update-time=consetetur</code><ul>
<li>Output only. Last update time.</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><strong>-p update-mask=string</strong><ul>
<li>Required. Mask of fields to update. At least one path must be supplied in this field. For the <code>FieldMask</code> definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask</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_locations-global-domains-validate-trust" class="btn btn-neutral float-right" title="Locations Global Domains Validate Trust"/>Next <span class="icon icon-circle-arrow-right"></span></a>
<a href="../projects_locations-global-domains-test-iam-permissions" class="btn btn-neutral" title="Locations Global Domains Test Iam Permissions"><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_locations-global-domains-test-iam-permissions" style="color: #fcfcfc;">&laquo; Previous</a></span>
<span style="margin-left: 15px"><a href="../projects_locations-global-domains-validate-trust" style="color: #fcfcfc">Next &raquo;</a></span>
</span>
</div>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink