mirror of
https://github.com/OMGeeky/google-apis-rs.git
synced 2026-01-27 12:20:17 +01:00
959 lines
39 KiB
HTML
959 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 Certificate Authorities 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-certificate-authorities-activate">Locations Certificate Authorities Activate</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../projects_locations-certificate-authorities-certificate-revocation-lists-get">Locations Certificate Authorities Certificate Revocation Lists Get</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../projects_locations-certificate-authorities-certificate-revocation-lists-get-iam-policy">Locations Certificate Authorities Certificate Revocation Lists Get Iam Policy</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../projects_locations-certificate-authorities-certificate-revocation-lists-list">Locations Certificate Authorities Certificate Revocation Lists List</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../projects_locations-certificate-authorities-certificate-revocation-lists-patch">Locations Certificate Authorities Certificate Revocation Lists Patch</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../projects_locations-certificate-authorities-certificate-revocation-lists-set-iam-policy">Locations Certificate Authorities Certificate Revocation Lists Set Iam Policy</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../projects_locations-certificate-authorities-certificate-revocation-lists-test-iam-permissions">Locations Certificate Authorities Certificate Revocation Lists Test Iam Permissions</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../projects_locations-certificate-authorities-certificates-create">Locations Certificate Authorities Certificates Create</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../projects_locations-certificate-authorities-certificates-get">Locations Certificate Authorities Certificates Get</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../projects_locations-certificate-authorities-certificates-list">Locations Certificate Authorities Certificates List</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../projects_locations-certificate-authorities-certificates-patch">Locations Certificate Authorities Certificates Patch</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../projects_locations-certificate-authorities-certificates-revoke">Locations Certificate Authorities Certificates Revoke</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../projects_locations-certificate-authorities-create">Locations Certificate Authorities Create</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../projects_locations-certificate-authorities-disable">Locations Certificate Authorities Disable</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../projects_locations-certificate-authorities-enable">Locations Certificate Authorities Enable</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../projects_locations-certificate-authorities-fetch">Locations Certificate Authorities Fetch</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../projects_locations-certificate-authorities-get">Locations Certificate Authorities Get</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../projects_locations-certificate-authorities-get-iam-policy">Locations Certificate Authorities Get Iam Policy</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../projects_locations-certificate-authorities-list">Locations Certificate Authorities List</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 current">
|
|
<a class="current" href=".">Locations Certificate Authorities 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-certificate-authorities-restore">Locations Certificate Authorities Restore</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../projects_locations-certificate-authorities-schedule-delete">Locations Certificate Authorities Schedule Delete</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../projects_locations-certificate-authorities-set-iam-policy">Locations Certificate Authorities Set Iam Policy</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../projects_locations-certificate-authorities-test-iam-permissions">Locations Certificate Authorities 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>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../projects_locations-reusable-configs-get">Locations Reusable Configs Get</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../projects_locations-reusable-configs-get-iam-policy">Locations Reusable Configs Get Iam Policy</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../projects_locations-reusable-configs-list">Locations Reusable Configs List</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../projects_locations-reusable-configs-set-iam-policy">Locations Reusable Configs Set Iam Policy</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../projects_locations-reusable-configs-test-iam-permissions">Locations Reusable Configs Test Iam Permissions</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 Certificate Authorities Patch</li>
|
|
<li class="wy-breadcrumbs-aside">
|
|
|
|
|
|
<a href="https://github.com/Byron/google-apis-rs/tree/main/gen/privateca1_beta1-cli" class="icon icon-github"> Edit on GitHub</a>
|
|
|
|
|
|
</li>
|
|
</ul>
|
|
<hr/>
|
|
</div>
|
|
<div role="main">
|
|
<div class="section">
|
|
<p>Update a CertificateAuthority.</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-beta1 --scope <scope> projects locations-certificate-authorities-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 CertificateAuthority in the format <code>projects/*/locations/*/certificateAuthorities/*</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>CertificateAuthority:
|
|
access-urls:
|
|
ca-certificate-access-url: string
|
|
crl-access-url: string
|
|
certificate-policy:
|
|
allowed-common-names: [string]
|
|
allowed-issuance-modes:
|
|
allow-config-based-issuance: boolean
|
|
allow-csr-based-issuance: boolean
|
|
allowed-sans:
|
|
allow-custom-sans: boolean
|
|
allow-globbing-dns-wildcards: boolean
|
|
allowed-dns-names: [string]
|
|
allowed-email-addresses: [string]
|
|
allowed-ips: [string]
|
|
allowed-uris: [string]
|
|
maximum-lifetime: string
|
|
overwrite-config-values:
|
|
reusable-config: string
|
|
reusable-config-values:
|
|
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
|
|
config:
|
|
public-key:
|
|
key: string
|
|
type: string
|
|
reusable-config:
|
|
reusable-config: string
|
|
reusable-config-values:
|
|
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
|
|
subject-config:
|
|
common-name: string
|
|
subject:
|
|
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]
|
|
create-time: string
|
|
delete-time: string
|
|
gcs-bucket: string
|
|
issuing-options:
|
|
include-ca-cert-url: boolean
|
|
include-crl-access-url: boolean
|
|
key-spec:
|
|
algorithm: string
|
|
cloud-kms-key-version: string
|
|
labels: { string: string }
|
|
lifetime: string
|
|
name: string
|
|
pem-ca-certificates: [string]
|
|
state: string
|
|
subordinate-config:
|
|
certificate-authority: string
|
|
pem-issuer-chain:
|
|
pem-certificates: [string]
|
|
tier: 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 .access-urls ca-certificate-access-url=tempor</code><ul>
|
|
<li>The URL where this CertificateAuthority's CA certificate is published. This will only be set for CAs that have been activated.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>crl-access-url=dolor</code></p>
|
|
<ul>
|
|
<li>The URL where this CertificateAuthority's CRLs are published. This will only be set for CAs that have been activated.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>..certificate-policy allowed-common-names=amet</code></p>
|
|
<ul>
|
|
<li>Optional. If any value is specified here, then all Certificates issued by the CertificateAuthority must match at least one listed value. If no value is specified, all values will be allowed for this fied. Glob patterns are also supported.</li>
|
|
<li>Each invocation of this argument appends the given value to the array.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>allowed-issuance-modes allow-config-based-issuance=true</code><ul>
|
|
<li>Required. When true, allows callers to create Certificates by specifying a CertificateConfig.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>allow-csr-based-issuance=false</code></p>
|
|
<ul>
|
|
<li>Required. When true, allows callers to create Certificates by specifying a CSR.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>..allowed-sans allow-custom-sans=false</code></p>
|
|
<ul>
|
|
<li>Optional. Specifies if to allow custom X509Extension values.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>allow-globbing-dns-wildcards=false</code><ul>
|
|
<li>Optional. Specifies if glob patterns used for allowed_dns_names allow wildcard certificates. If this is set, certificate requests with wildcard domains will be permitted to match a glob pattern specified in allowed_dns_names. Otherwise, certificate requests with wildcard domains will be permitted only if allowed_dns_names contains a literal wildcard.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>allowed-dns-names=dolor</code><ul>
|
|
<li>Optional. Contains valid, fully-qualified host names. Glob patterns are also supported. To allow an explicit wildcard certificate, escape with backlash (i.e. <code>\*</code>). E.g. for globbed entries: <code>*bar.com</code> will allow <code>foo.bar.com</code>, but not <code>*.bar.com</code>, unless the allow_globbing_dns_wildcards field is set. E.g. for wildcard entries: <code>\*.bar.com</code> will allow <code>*.bar.com</code>, but not <code>foo.bar.com</code>.</li>
|
|
<li>Each invocation of this argument appends the given value to the array.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>allowed-email-addresses=sadipscing</code><ul>
|
|
<li>Optional. Contains valid RFC 2822 E-mail addresses. Glob patterns are also supported.</li>
|
|
<li>Each invocation of this argument appends the given value to the array.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>allowed-ips=dolor</code><ul>
|
|
<li>Optional. Contains valid 32-bit IPv4 addresses and subnet ranges or RFC 4291 IPv6 addresses and subnet ranges. Subnet ranges are specified using the '/' notation (e.g. 10.0.0.0/8, 2001:700:300:1800::/64). Glob patterns are supported only for ip address entries (i.e. not for subnet ranges).</li>
|
|
<li>Each invocation of this argument appends the given value to the array.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>allowed-uris=dolor</code></p>
|
|
<ul>
|
|
<li>Optional. Contains valid RFC 3986 URIs. Glob patterns are also supported. To match across path seperators (i.e. '/') use the double star glob pattern (i.e. '**').</li>
|
|
<li>Each invocation of this argument appends the given value to the array.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>.. maximum-lifetime=consetetur</code></p>
|
|
<ul>
|
|
<li>Optional. The maximum lifetime allowed by the CertificateAuthority. Note that if the any part if the issuing chain expires before a Certificate's requested maximum_lifetime, the effective lifetime will be explicitly truncated.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>overwrite-config-values reusable-config=et</code><ul>
|
|
<li>Required. A resource path to a ReusableConfig in the format <code>projects/*/locations/*/reusableConfigs/*</code>.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>reusable-config-values aia-ocsp-servers=sit</code><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=60</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=true</code><ul>
|
|
<li>The key may be used sign certificate revocation lists.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>data-encipherment=false</code><ul>
|
|
<li>The key may be used to encipher data.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>decipher-only=false</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=true</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=true</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>......config.public-key key=consetetur</code></p>
|
|
<ul>
|
|
<li>Required. A public key. When this is specified in a request, the padding and encoding can be any of the options described by the respective 'KeyType' value. When this is generated by the service, it will always be an RFC 5280 <a href="https://tools.ietf.org/html/rfc5280#section-4.1">SubjectPublicKeyInfo</a> structure containing an algorithm identifier and a key.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>type=dolor</code></p>
|
|
<ul>
|
|
<li>Optional. The type of public key. If specified, it must match the public key used for the<code>key</code> field.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>..reusable-config reusable-config=amet</code></p>
|
|
<ul>
|
|
<li>Required. A resource path to a ReusableConfig in the format <code>projects/*/locations/*/reusableConfigs/*</code>.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>reusable-config-values aia-ocsp-servers=et</code><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=13</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=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=true</code><ul>
|
|
<li>The key may be used in a key agreement protocol.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>key-encipherment=true</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=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=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=true</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>.....subject-config common-name=amet</code></p>
|
|
<ul>
|
|
<li>Optional. The "common name" of the distinguished name.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>subject country-code=ipsum</code><ul>
|
|
<li>The country code of the subject.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>locality=lorem</code><ul>
|
|
<li>The locality or city of the subject.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>organization=dolores</code><ul>
|
|
<li>The organization of the subject.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>organizational-unit=consetetur</code><ul>
|
|
<li>The organizational_unit of the subject.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>postal-code=stet</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=consetetur</code></p>
|
|
<ul>
|
|
<li>The street address of the subject.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>..subject-alt-name dns-names=takimata</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=sed</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=nonumy</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=sea</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>.... create-time=eos</code></p>
|
|
<ul>
|
|
<li>Output only. The time at which this CertificateAuthority was created.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>delete-time=dolore</code><ul>
|
|
<li>Output only. The time at which this CertificateAuthority will be deleted, if scheduled for deletion.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>gcs-bucket=accusam</code><ul>
|
|
<li>Immutable. The name of a Cloud Storage bucket where this CertificateAuthority will publish content, such as the CA certificate and CRLs. This must be a bucket name, without any prefixes (such as <code>gs://</code>) or suffixes (such as <code>.googleapis.com</code>). For example, to use a bucket named <code>my-bucket</code>, you would simply specify <code>my-bucket</code>. If not specified, a managed bucket will be created.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>issuing-options include-ca-cert-url=true</code><ul>
|
|
<li>Required. When true, includes a URL to the issuing CA certificate in the "authority information access" X.509 extension.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>include-crl-access-url=false</code></p>
|
|
<ul>
|
|
<li>Required. When true, includes a URL to the CRL corresponding to certificates issued from a CertificateAuthority. CRLs will expire 7 days from their creation. However, we will rebuild daily. CRLs are also rebuilt shortly after a certificate is revoked.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>..key-spec algorithm=eirmod</code></p>
|
|
<ul>
|
|
<li>Required. The algorithm to use for creating a managed Cloud KMS key for a for a simplified experience. All managed keys will be have their ProtectionLevel as <code>HSM</code>.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>cloud-kms-key-version=sed</code></p>
|
|
<ul>
|
|
<li>Required. The resource name for an existing Cloud KMS CryptoKeyVersion in the format <code>projects/*/locations/*/keyRings/*/cryptoKeys/*/cryptoKeyVersions/*</code>. This option enables full flexibility in the key's capabilities and properties.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>.. labels=key=at</code></p>
|
|
<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=stet</code><ul>
|
|
<li>Required. The desired lifetime of the CA certificate. Used to create the "not_before_time" and "not_after_time" fields inside an X.509 certificate.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>name=sit</code><ul>
|
|
<li>Output only. The resource name for this CertificateAuthority in the format <code>projects/*/locations/*/certificateAuthorities/*</code>.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>pem-ca-certificates=ipsum</code><ul>
|
|
<li>Output only. This CertificateAuthority's certificate chain, including the current CertificateAuthority's certificate. Ordered such that the root issuer is the final element (consistent with RFC 5246). For a self-signed CA, this will only list the current CertificateAuthority's certificate.</li>
|
|
<li>Each invocation of this argument appends the given value to the array.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>state=lorem</code><ul>
|
|
<li>Output only. The State for this CertificateAuthority.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>subordinate-config certificate-authority=dolor</code><ul>
|
|
<li>Required. This can refer to a CertificateAuthority that was used to create a subordinate CertificateAuthority. This field is used for information and usability purposes only. The resource name is in the format <code>projects/*/locations/*/certificateAuthorities/*</code>.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>pem-issuer-chain pem-certificates=amet</code></p>
|
|
<ul>
|
|
<li>Required. Expected to be in leaf-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>
|
|
<p><code>... tier=magna</code></p>
|
|
<ul>
|
|
<li>Required. Immutable. The Tier of this CertificateAuthority.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>type=magna</code><ul>
|
|
<li>Required. Immutable. The Type of this CertificateAuthority.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>update-time=invidunt</code><ul>
|
|
<li>Output only. The time at which this CertificateAuthority 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-certificate-authorities-restore" class="btn btn-neutral float-right" title="Locations Certificate Authorities Restore"/>Next <span class="icon icon-circle-arrow-right"></span></a>
|
|
|
|
|
|
<a href="../projects_locations-certificate-authorities-list" class="btn btn-neutral" title="Locations Certificate Authorities 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-certificate-authorities-list" style="color: #fcfcfc;">« Previous</a></span>
|
|
<span style="margin-left: 15px"><a href="../projects_locations-certificate-authorities-restore" style="color: #fcfcfc">Next »</a></span>
|
|
</span>
|
|
</div>
|
|
</body>
|
|
</html> |