mirror of
https://github.com/OMGeeky/google-apis-rs.git
synced 2026-01-27 04:10:02 +01:00
1028 lines
39 KiB
HTML
1028 lines
39 KiB
HTML
<!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 Ca Pools Certificates Patch - Certificate Authority Service v3.0.0+20220209</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"> Certificate Authority Service v3.0.0+20220209</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-ca-pools-certificate-authorities-activate">Locations Ca Pools Certificate Authorities Activate</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../projects_locations-ca-pools-certificate-authorities-certificate-revocation-lists-get">Locations Ca Pools Certificate Authorities Certificate Revocation Lists Get</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../projects_locations-ca-pools-certificate-authorities-certificate-revocation-lists-get-iam-policy">Locations Ca Pools Certificate Authorities Certificate Revocation Lists Get Iam Policy</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../projects_locations-ca-pools-certificate-authorities-certificate-revocation-lists-list">Locations Ca Pools Certificate Authorities Certificate Revocation Lists List</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../projects_locations-ca-pools-certificate-authorities-certificate-revocation-lists-patch">Locations Ca Pools Certificate Authorities Certificate Revocation Lists Patch</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../projects_locations-ca-pools-certificate-authorities-certificate-revocation-lists-set-iam-policy">Locations Ca Pools Certificate Authorities Certificate Revocation Lists Set Iam Policy</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../projects_locations-ca-pools-certificate-authorities-certificate-revocation-lists-test-iam-permissions">Locations Ca Pools Certificate Authorities Certificate Revocation Lists Test Iam Permissions</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../projects_locations-ca-pools-certificate-authorities-create">Locations Ca Pools Certificate Authorities Create</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../projects_locations-ca-pools-certificate-authorities-delete">Locations Ca Pools Certificate Authorities Delete</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../projects_locations-ca-pools-certificate-authorities-disable">Locations Ca Pools Certificate Authorities Disable</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../projects_locations-ca-pools-certificate-authorities-enable">Locations Ca Pools Certificate Authorities Enable</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../projects_locations-ca-pools-certificate-authorities-fetch">Locations Ca Pools Certificate Authorities Fetch</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../projects_locations-ca-pools-certificate-authorities-get">Locations Ca Pools Certificate Authorities Get</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../projects_locations-ca-pools-certificate-authorities-list">Locations Ca Pools Certificate Authorities List</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../projects_locations-ca-pools-certificate-authorities-patch">Locations Ca Pools Certificate Authorities Patch</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../projects_locations-ca-pools-certificate-authorities-undelete">Locations Ca Pools Certificate Authorities Undelete</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../projects_locations-ca-pools-certificates-create">Locations Ca Pools Certificates Create</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../projects_locations-ca-pools-certificates-get">Locations Ca Pools Certificates Get</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../projects_locations-ca-pools-certificates-list">Locations Ca Pools Certificates List</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 current">
|
|
<a class="current" href=".">Locations Ca Pools Certificates Patch</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-ca-pools-certificates-revoke">Locations Ca Pools Certificates Revoke</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../projects_locations-ca-pools-create">Locations Ca Pools Create</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../projects_locations-ca-pools-delete">Locations Ca Pools Delete</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../projects_locations-ca-pools-fetch-ca-certs">Locations Ca Pools Fetch Ca Certs</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../projects_locations-ca-pools-get">Locations Ca Pools Get</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../projects_locations-ca-pools-get-iam-policy">Locations Ca Pools Get Iam Policy</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../projects_locations-ca-pools-list">Locations Ca Pools List</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../projects_locations-ca-pools-patch">Locations Ca Pools Patch</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../projects_locations-ca-pools-set-iam-policy">Locations Ca Pools Set Iam Policy</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../projects_locations-ca-pools-test-iam-permissions">Locations Ca Pools Test Iam Permissions</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../projects_locations-certificate-templates-create">Locations Certificate Templates Create</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../projects_locations-certificate-templates-delete">Locations Certificate Templates Delete</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../projects_locations-certificate-templates-get">Locations Certificate Templates Get</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../projects_locations-certificate-templates-get-iam-policy">Locations Certificate Templates Get Iam Policy</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../projects_locations-certificate-templates-list">Locations Certificate Templates List</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../projects_locations-certificate-templates-patch">Locations Certificate Templates Patch</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../projects_locations-certificate-templates-set-iam-policy">Locations Certificate Templates Set Iam Policy</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../projects_locations-certificate-templates-test-iam-permissions">Locations Certificate Templates Test Iam Permissions</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../projects_locations-get">Locations Get</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../projects_locations-list">Locations List</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../projects_locations-operations-cancel">Locations Operations Cancel</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../projects_locations-operations-delete">Locations Operations Delete</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../projects_locations-operations-get">Locations Operations Get</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../projects_locations-operations-list">Locations Operations List</a>
|
|
|
|
</li>
|
|
|
|
|
|
|
|
|
|
</ul>
|
|
|
|
</div>
|
|
|
|
</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> »</li>
|
|
<li>Locations Ca Pools Certificates Patch</li>
|
|
<li class="wy-breadcrumbs-aside">
|
|
|
|
|
|
<a href="https://github.com/Byron/google-apis-rs/tree/main/gen/privateca1-cli" class="icon icon-github"> Edit on GitHub</a>
|
|
|
|
|
|
</li>
|
|
</ul>
|
|
<hr/>
|
|
</div>
|
|
<div role="main">
|
|
<div class="section">
|
|
<p>Update a Certificate. Currently, the only field you can update is the labels field.</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>privateca1 --scope <scope> projects locations-ca-pools-certificates-patch ...</code></p>
|
|
<h1 id="required-scalar-argument">Required Scalar Argument</h1>
|
|
<ul>
|
|
<li><strong><name></strong> <em>(string)</em><ul>
|
|
<li>Output only. The resource name for this Certificate in the format <code>projects/*/locations/*/caPools/*/certificates/*</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>Certificate:
|
|
certificate-description:
|
|
aia-issuing-certificate-urls: [string]
|
|
authority-key-id:
|
|
key-id: string
|
|
cert-fingerprint:
|
|
sha256-hash: string
|
|
crl-distribution-points: [string]
|
|
public-key:
|
|
format: string
|
|
key: string
|
|
subject-description:
|
|
hex-serial-number: string
|
|
lifetime: string
|
|
not-after-time: string
|
|
not-before-time: string
|
|
subject:
|
|
common-name: string
|
|
country-code: string
|
|
locality: string
|
|
organization: string
|
|
organizational-unit: string
|
|
postal-code: string
|
|
province: string
|
|
street-address: string
|
|
subject-alt-name:
|
|
dns-names: [string]
|
|
email-addresses: [string]
|
|
ip-addresses: [string]
|
|
uris: [string]
|
|
subject-key-id:
|
|
key-id: string
|
|
x509-description:
|
|
aia-ocsp-servers: [string]
|
|
ca-options:
|
|
is-ca: boolean
|
|
max-issuer-path-length: integer
|
|
key-usage:
|
|
base-key-usage:
|
|
cert-sign: boolean
|
|
content-commitment: boolean
|
|
crl-sign: boolean
|
|
data-encipherment: boolean
|
|
decipher-only: boolean
|
|
digital-signature: boolean
|
|
encipher-only: boolean
|
|
key-agreement: boolean
|
|
key-encipherment: boolean
|
|
extended-key-usage:
|
|
client-auth: boolean
|
|
code-signing: boolean
|
|
email-protection: boolean
|
|
ocsp-signing: boolean
|
|
server-auth: boolean
|
|
time-stamping: boolean
|
|
certificate-template: string
|
|
config:
|
|
public-key:
|
|
format: string
|
|
key: string
|
|
subject-config:
|
|
subject:
|
|
common-name: string
|
|
country-code: string
|
|
locality: string
|
|
organization: string
|
|
organizational-unit: string
|
|
postal-code: string
|
|
province: string
|
|
street-address: string
|
|
subject-alt-name:
|
|
dns-names: [string]
|
|
email-addresses: [string]
|
|
ip-addresses: [string]
|
|
uris: [string]
|
|
x509-config:
|
|
aia-ocsp-servers: [string]
|
|
ca-options:
|
|
is-ca: boolean
|
|
max-issuer-path-length: integer
|
|
key-usage:
|
|
base-key-usage:
|
|
cert-sign: boolean
|
|
content-commitment: boolean
|
|
crl-sign: boolean
|
|
data-encipherment: boolean
|
|
decipher-only: boolean
|
|
digital-signature: boolean
|
|
encipher-only: boolean
|
|
key-agreement: boolean
|
|
key-encipherment: boolean
|
|
extended-key-usage:
|
|
client-auth: boolean
|
|
code-signing: boolean
|
|
email-protection: boolean
|
|
ocsp-signing: boolean
|
|
server-auth: boolean
|
|
time-stamping: boolean
|
|
create-time: string
|
|
issuer-certificate-authority: string
|
|
labels: { string: string }
|
|
lifetime: string
|
|
name: string
|
|
pem-certificate: string
|
|
pem-certificate-chain: [string]
|
|
pem-csr: string
|
|
revocation-details:
|
|
revocation-state: string
|
|
revocation-time: string
|
|
subject-mode: 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-description aia-issuing-certificate-urls=magna</code><ul>
|
|
<li>Describes lists of issuer CA certificate URLs that appear in the "Authority Information Access" extension in the certificate.</li>
|
|
<li>Each invocation of this argument appends the given value to the array.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>authority-key-id key-id=diam</code></p>
|
|
<ul>
|
|
<li>Optional. The value of this KeyId encoded in lowercase hexadecimal. This is most likely the 160 bit SHA-1 hash of the public key.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>..cert-fingerprint sha256-hash=nonumy</code></p>
|
|
<ul>
|
|
<li>The SHA 256 hash, encoded in hexadecimal, of the DER x509 certificate.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>.. crl-distribution-points=et</code></p>
|
|
<ul>
|
|
<li>Describes a list of locations to obtain CRL information, i.e. the DistributionPoint.fullName described by https://tools.ietf.org/html/rfc5280#section-4.2.1.13</li>
|
|
<li>Each invocation of this argument appends the given value to the array.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>public-key format=sanctus</code><ul>
|
|
<li>Required. The format of the public key.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>key=accusam</code></p>
|
|
<ul>
|
|
<li>Required. A public key. The padding and encoding must match with the <code>KeyFormat</code> value specified for the <code>format</code> field.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>..subject-description hex-serial-number=tempor</code></p>
|
|
<ul>
|
|
<li>The serial number encoded in lowercase hexadecimal.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>lifetime=sed</code><ul>
|
|
<li>For convenience, the actual lifetime of an issued certificate.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>not-after-time=est</code><ul>
|
|
<li>The time after which the certificate is expired. Per RFC 5280, the validity period for a certificate is the period of time from not_before_time through not_after_time, inclusive. Corresponds to 'not_before_time' + 'lifetime' - 1 second.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>not-before-time=takimata</code><ul>
|
|
<li>The time at which the certificate becomes valid.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>subject common-name=dolor</code><ul>
|
|
<li>The "common name" of the subject.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>country-code=diam</code><ul>
|
|
<li>The country code of the subject.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>locality=at</code><ul>
|
|
<li>The locality or city of the subject.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>organization=erat</code><ul>
|
|
<li>The organization of the subject.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>organizational-unit=justo</code><ul>
|
|
<li>The organizational_unit of the subject.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>postal-code=ipsum</code><ul>
|
|
<li>The postal code of the subject.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>province=accusam</code><ul>
|
|
<li>The province, territory, or regional state of the subject.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>street-address=dolores</code></p>
|
|
<ul>
|
|
<li>The street address of the subject.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>..subject-alt-name dns-names=consetetur</code></p>
|
|
<ul>
|
|
<li>Contains only valid, fully-qualified host names.</li>
|
|
<li>Each invocation of this argument appends the given value to the array.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>email-addresses=no</code><ul>
|
|
<li>Contains only valid RFC 2822 E-mail addresses.</li>
|
|
<li>Each invocation of this argument appends the given value to the array.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>ip-addresses=justo</code><ul>
|
|
<li>Contains only valid 32-bit IPv4 addresses or RFC 4291 IPv6 addresses.</li>
|
|
<li>Each invocation of this argument appends the given value to the array.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>uris=sadipscing</code></p>
|
|
<ul>
|
|
<li>Contains only valid RFC 3986 URIs.</li>
|
|
<li>Each invocation of this argument appends the given value to the array.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>...subject-key-id key-id=diam</code></p>
|
|
<ul>
|
|
<li>Optional. The value of this KeyId encoded in lowercase hexadecimal. This is most likely the 160 bit SHA-1 hash of the public key.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>..x509-description aia-ocsp-servers=sea</code></p>
|
|
<ul>
|
|
<li>Optional. Describes Online Certificate Status Protocol (OCSP) endpoint addresses that appear in the "Authority Information Access" extension in the certificate.</li>
|
|
<li>Each invocation of this argument appends the given value to the array.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>ca-options is-ca=true</code><ul>
|
|
<li>Optional. Refers to the "CA" X.509 extension, which is a boolean value. When this value is missing, the extension will be omitted from the CA certificate.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>max-issuer-path-length=86</code></p>
|
|
<ul>
|
|
<li>Optional. Refers to the path length restriction X.509 extension. For a CA certificate, this value describes the depth of subordinate CA certificates that are allowed. If this value is less than 0, the request will fail. If this value is missing, the max path length will be omitted from the CA certificate.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>..key-usage.base-key-usage cert-sign=true</code></p>
|
|
<ul>
|
|
<li>The key may be used to sign certificates.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>content-commitment=true</code><ul>
|
|
<li>The key may be used for cryptographic commitments. Note that this may also be referred to as "non-repudiation".</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>crl-sign=false</code><ul>
|
|
<li>The key may be used sign certificate revocation lists.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>data-encipherment=true</code><ul>
|
|
<li>The key may be used to encipher data.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>decipher-only=true</code><ul>
|
|
<li>The key may be used to decipher only.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>digital-signature=false</code><ul>
|
|
<li>The key may be used for digital signatures.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>encipher-only=false</code><ul>
|
|
<li>The key may be used to encipher only.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>key-agreement=false</code><ul>
|
|
<li>The key may be used in a key agreement protocol.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>key-encipherment=false</code></p>
|
|
<ul>
|
|
<li>The key may be used to encipher other keys.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>..extended-key-usage client-auth=true</code></p>
|
|
<ul>
|
|
<li>Corresponds to OID 1.3.6.1.5.5.7.3.2. Officially described as "TLS WWW client authentication", though regularly used for non-WWW TLS.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>code-signing=false</code><ul>
|
|
<li>Corresponds to OID 1.3.6.1.5.5.7.3.3. Officially described as "Signing of downloadable executable code client authentication".</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>email-protection=false</code><ul>
|
|
<li>Corresponds to OID 1.3.6.1.5.5.7.3.4. Officially described as "Email protection".</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>ocsp-signing=false</code><ul>
|
|
<li>Corresponds to OID 1.3.6.1.5.5.7.3.9. Officially described as "Signing OCSP responses".</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>server-auth=false</code><ul>
|
|
<li>Corresponds to OID 1.3.6.1.5.5.7.3.1. Officially described as "TLS WWW server authentication", though regularly used for non-WWW TLS.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>time-stamping=false</code></p>
|
|
<ul>
|
|
<li>Corresponds to OID 1.3.6.1.5.5.7.3.8. Officially described as "Binding the hash of an object to a time".</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>..... certificate-template=erat</code></p>
|
|
<ul>
|
|
<li>Immutable. The resource name for a CertificateTemplate used to issue this certificate, in the format <code>projects/*/locations/*/certificateTemplates/*</code>. If this is specified, the caller must have the necessary permission to use this template. If this is omitted, no template will be used. This template must be in the same location as the Certificate.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>config.public-key format=erat</code><ul>
|
|
<li>Required. The format of the public key.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>key=dolores</code></p>
|
|
<ul>
|
|
<li>Required. A public key. The padding and encoding must match with the <code>KeyFormat</code> value specified for the <code>format</code> field.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>..subject-config.subject common-name=ipsum</code></p>
|
|
<ul>
|
|
<li>The "common name" of the subject.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>country-code=voluptua.</code><ul>
|
|
<li>The country code of the subject.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>locality=eos</code><ul>
|
|
<li>The locality or city of the subject.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>organization=duo</code><ul>
|
|
<li>The organization of the subject.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>organizational-unit=elitr</code><ul>
|
|
<li>The organizational_unit of the subject.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>postal-code=consetetur</code><ul>
|
|
<li>The postal code of the subject.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>province=et</code><ul>
|
|
<li>The province, territory, or regional state of the subject.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>street-address=clita</code></p>
|
|
<ul>
|
|
<li>The street address of the subject.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>..subject-alt-name dns-names=sit</code></p>
|
|
<ul>
|
|
<li>Contains only valid, fully-qualified host names.</li>
|
|
<li>Each invocation of this argument appends the given value to the array.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>email-addresses=takimata</code><ul>
|
|
<li>Contains only valid RFC 2822 E-mail addresses.</li>
|
|
<li>Each invocation of this argument appends the given value to the array.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>ip-addresses=erat</code><ul>
|
|
<li>Contains only valid 32-bit IPv4 addresses or RFC 4291 IPv6 addresses.</li>
|
|
<li>Each invocation of this argument appends the given value to the array.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>uris=diam</code></p>
|
|
<ul>
|
|
<li>Contains only valid RFC 3986 URIs.</li>
|
|
<li>Each invocation of this argument appends the given value to the array.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>...x509-config aia-ocsp-servers=nonumy</code></p>
|
|
<ul>
|
|
<li>Optional. Describes Online Certificate Status Protocol (OCSP) endpoint addresses that appear in the "Authority Information Access" extension in the certificate.</li>
|
|
<li>Each invocation of this argument appends the given value to the array.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>ca-options is-ca=false</code><ul>
|
|
<li>Optional. Refers to the "CA" X.509 extension, which is a boolean value. When this value is missing, the extension will be omitted from the CA certificate.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>max-issuer-path-length=9</code></p>
|
|
<ul>
|
|
<li>Optional. Refers to the path length restriction X.509 extension. For a CA certificate, this value describes the depth of subordinate CA certificates that are allowed. If this value is less than 0, the request will fail. If this value is missing, the max path length will be omitted from the CA certificate.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>..key-usage.base-key-usage cert-sign=false</code></p>
|
|
<ul>
|
|
<li>The key may be used to sign certificates.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>content-commitment=false</code><ul>
|
|
<li>The key may be used for cryptographic commitments. Note that this may also be referred to as "non-repudiation".</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>crl-sign=false</code><ul>
|
|
<li>The key may be used sign certificate revocation lists.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>data-encipherment=true</code><ul>
|
|
<li>The key may be used to encipher data.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>decipher-only=true</code><ul>
|
|
<li>The key may be used to decipher only.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>digital-signature=true</code><ul>
|
|
<li>The key may be used for digital signatures.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>encipher-only=false</code><ul>
|
|
<li>The key may be used to encipher only.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>key-agreement=false</code><ul>
|
|
<li>The key may be used in a key agreement protocol.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>key-encipherment=false</code></p>
|
|
<ul>
|
|
<li>The key may be used to encipher other keys.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>..extended-key-usage client-auth=false</code></p>
|
|
<ul>
|
|
<li>Corresponds to OID 1.3.6.1.5.5.7.3.2. Officially described as "TLS WWW client authentication", though regularly used for non-WWW TLS.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>code-signing=false</code><ul>
|
|
<li>Corresponds to OID 1.3.6.1.5.5.7.3.3. Officially described as "Signing of downloadable executable code client authentication".</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>email-protection=true</code><ul>
|
|
<li>Corresponds to OID 1.3.6.1.5.5.7.3.4. Officially described as "Email protection".</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>ocsp-signing=true</code><ul>
|
|
<li>Corresponds to OID 1.3.6.1.5.5.7.3.9. Officially described as "Signing OCSP responses".</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>server-auth=true</code><ul>
|
|
<li>Corresponds to OID 1.3.6.1.5.5.7.3.1. Officially described as "TLS WWW server authentication", though regularly used for non-WWW TLS.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>time-stamping=false</code></p>
|
|
<ul>
|
|
<li>Corresponds to OID 1.3.6.1.5.5.7.3.8. Officially described as "Binding the hash of an object to a time".</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>..... create-time=kasd</code></p>
|
|
<ul>
|
|
<li>Output only. The time at which this Certificate was created.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>issuer-certificate-authority=lorem</code><ul>
|
|
<li>Output only. The resource name of the issuing CertificateAuthority in the format <code>projects/*/locations/*/caPools/*/certificateAuthorities/*</code>.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>labels=key=sit</code><ul>
|
|
<li>Optional. Labels with user-defined metadata.</li>
|
|
<li>the value will be associated with the given <code>key</code></li>
|
|
</ul>
|
|
</li>
|
|
<li><code>lifetime=kasd</code><ul>
|
|
<li>Required. Immutable. The desired lifetime of a certificate. Used to create the "not_before_time" and "not_after_time" fields inside an X.509 certificate. Note that the lifetime may be truncated if it would extend past the life of any certificate authority in the issuing chain.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>name=tempor</code><ul>
|
|
<li>Output only. The resource name for this Certificate in the format <code>projects/*/locations/*/caPools/*/certificates/*</code>.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>pem-certificate=dolor</code><ul>
|
|
<li>Output only. The pem-encoded, signed X.509 certificate.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>pem-certificate-chain=amet</code><ul>
|
|
<li>Output only. The chain that may be used to verify the X.509 certificate. Expected to be in issuer-to-root order according to RFC 5246.</li>
|
|
<li>Each invocation of this argument appends the given value to the array.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>pem-csr=sit</code><ul>
|
|
<li>Immutable. A pem-encoded X.509 certificate signing request (CSR).</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>revocation-details revocation-state=rebum.</code><ul>
|
|
<li>Indicates why a Certificate was revoked.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>revocation-time=sea</code></p>
|
|
<ul>
|
|
<li>The time at which this Certificate was revoked.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>.. subject-mode=ipsum</code></p>
|
|
<ul>
|
|
<li>Immutable. Specifies how the Certificate's identity fields are to be decided. If this is omitted, the <code>DEFAULT</code> subject mode will be used.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>update-time=ipsum</code><ul>
|
|
<li>Output only. The time at which this Certificate was 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-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 request-id=string</strong></p>
|
|
<ul>
|
|
<li>Optional. An ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and t he request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><strong>-p update-mask=string</strong></p>
|
|
<ul>
|
|
<li>Required. A list of fields to be updated in this request.</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="../projects_locations-ca-pools-certificates-revoke" class="btn btn-neutral float-right" title="Locations Ca Pools Certificates Revoke"/>Next <span class="icon icon-circle-arrow-right"></span></a>
|
|
|
|
|
|
<a href="../projects_locations-ca-pools-certificates-list" class="btn btn-neutral" title="Locations Ca Pools Certificates List"><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-ca-pools-certificates-list" style="color: #fcfcfc;">« Previous</a></span>
|
|
<span style="margin-left: 15px"><a href="../projects_locations-ca-pools-certificates-revoke" style="color: #fcfcfc">Next »</a></span>
|
|
</span>
|
|
</div>
|
|
</body>
|
|
</html> |