| <html><body> |
| <style> |
| |
| body, h1, h2, h3, div, span, p, pre, a { |
| margin: 0; |
| padding: 0; |
| border: 0; |
| font-weight: inherit; |
| font-style: inherit; |
| font-size: 100%; |
| font-family: inherit; |
| vertical-align: baseline; |
| } |
| |
| body { |
| font-size: 13px; |
| padding: 1em; |
| } |
| |
| h1 { |
| font-size: 26px; |
| margin-bottom: 1em; |
| } |
| |
| h2 { |
| font-size: 24px; |
| margin-bottom: 1em; |
| } |
| |
| h3 { |
| font-size: 20px; |
| margin-bottom: 1em; |
| margin-top: 1em; |
| } |
| |
| pre, code { |
| line-height: 1.5; |
| font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; |
| } |
| |
| pre { |
| margin-top: 0.5em; |
| } |
| |
| h1, h2, h3, p { |
| font-family: Arial, sans serif; |
| } |
| |
| h1, h2, h3 { |
| border-bottom: solid #CCC 1px; |
| } |
| |
| .toc_element { |
| margin-top: 0.5em; |
| } |
| |
| .firstline { |
| margin-left: 2 em; |
| } |
| |
| .method { |
| margin-top: 1em; |
| border: solid 1px #CCC; |
| padding: 1em; |
| background: #EEE; |
| } |
| |
| .details { |
| font-weight: bold; |
| font-size: 14px; |
| } |
| |
| </style> |
| |
| <h1><a href="privateca_v1.html">Certificate Authority API</a> . <a href="privateca_v1.projects.html">projects</a> . <a href="privateca_v1.projects.locations.html">locations</a> . <a href="privateca_v1.projects.locations.caPools.html">caPools</a> . <a href="privateca_v1.projects.locations.caPools.certificateAuthorities.html">certificateAuthorities</a></h1> |
| <h2>Instance Methods</h2> |
| <p class="toc_element"> |
| <code><a href="privateca_v1.projects.locations.caPools.certificateAuthorities.certificateRevocationLists.html">certificateRevocationLists()</a></code> |
| </p> |
| <p class="firstline">Returns the certificateRevocationLists Resource.</p> |
| |
| <p class="toc_element"> |
| <code><a href="#activate">activate(name, body=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Activate a CertificateAuthority that is in state AWAITING_USER_ACTIVATION and is of type SUBORDINATE. After the parent Certificate Authority signs a certificate signing request from FetchCertificateAuthorityCsr, this method can complete the activation process.</p> |
| <p class="toc_element"> |
| <code><a href="#close">close()</a></code></p> |
| <p class="firstline">Close httplib2 connections.</p> |
| <p class="toc_element"> |
| <code><a href="#create">create(parent, body=None, certificateAuthorityId=None, requestId=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Create a new CertificateAuthority in a given Project and Location.</p> |
| <p class="toc_element"> |
| <code><a href="#delete">delete(name, ignoreActiveCertificates=None, requestId=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Delete a CertificateAuthority.</p> |
| <p class="toc_element"> |
| <code><a href="#disable">disable(name, body=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Disable a CertificateAuthority.</p> |
| <p class="toc_element"> |
| <code><a href="#enable">enable(name, body=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Enable a CertificateAuthority.</p> |
| <p class="toc_element"> |
| <code><a href="#fetch">fetch(name, x__xgafv=None)</a></code></p> |
| <p class="firstline">Fetch a certificate signing request (CSR) from a CertificateAuthority that is in state AWAITING_USER_ACTIVATION and is of type SUBORDINATE. The CSR must then be signed by the desired parent Certificate Authority, which could be another CertificateAuthority resource, or could be an on-prem certificate authority. See also ActivateCertificateAuthority.</p> |
| <p class="toc_element"> |
| <code><a href="#get">get(name, x__xgafv=None)</a></code></p> |
| <p class="firstline">Returns a CertificateAuthority.</p> |
| <p class="toc_element"> |
| <code><a href="#list">list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Lists CertificateAuthorities.</p> |
| <p class="toc_element"> |
| <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> |
| <p class="firstline">Retrieves the next page of results.</p> |
| <p class="toc_element"> |
| <code><a href="#patch">patch(name, body=None, requestId=None, updateMask=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Update a CertificateAuthority.</p> |
| <p class="toc_element"> |
| <code><a href="#undelete">undelete(name, body=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Undelete a CertificateAuthority that has been deleted.</p> |
| <h3>Method Details</h3> |
| <div class="method"> |
| <code class="details" id="activate">activate(name, body=None, x__xgafv=None)</code> |
| <pre>Activate a CertificateAuthority that is in state AWAITING_USER_ACTIVATION and is of type SUBORDINATE. After the parent Certificate Authority signs a certificate signing request from FetchCertificateAuthorityCsr, this method can complete the activation process. |
| |
| Args: |
| name: string, Required. The resource name for this CertificateAuthority in the format `projects/*/locations/*/caPools/*/certificateAuthorities/*`. (required) |
| body: object, The request body. |
| The object takes the form of: |
| |
| { # Request message for CertificateAuthorityService.ActivateCertificateAuthority. |
| "pemCaCertificate": "A String", # Required. The signed CA certificate issued from FetchCertificateAuthorityCsrResponse.pem_csr. |
| "requestId": "A String", # 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). |
| "subordinateConfig": { # Describes a subordinate CA's issuers. This is either a resource name to a known issuing CertificateAuthority, or a PEM issuer certificate chain. # Required. Must include information about the issuer of 'pem_ca_certificate', and any further issuers until the self-signed CA. |
| "certificateAuthority": "A String", # 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 `projects/*/locations/*/caPools/*/certificateAuthorities/*`. |
| "pemIssuerChain": { # This message describes a subordinate CA's issuer certificate chain. This wrapper exists for compatibility reasons. # Required. Contains the PEM certificate chain for the issuers of this CertificateAuthority, but not pem certificate for this CA itself. |
| "pemCertificates": [ # Required. Expected to be in leaf-to-root order according to RFC 5246. |
| "A String", |
| ], |
| }, |
| }, |
| } |
| |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # This resource represents a long-running operation that is the result of a network API call. |
| "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available. |
| "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation. |
| "code": 42, # The status code, which should be an enum value of google.rpc.Code. |
| "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. |
| { |
| "a_key": "", # Properties of the object. Contains field @type with type URL. |
| }, |
| ], |
| "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. |
| }, |
| "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any. |
| "a_key": "", # Properties of the object. Contains field @type with type URL. |
| }, |
| "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`. |
| "response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. |
| "a_key": "", # Properties of the object. Contains field @type with type URL. |
| }, |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="close">close()</code> |
| <pre>Close httplib2 connections.</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="create">create(parent, body=None, certificateAuthorityId=None, requestId=None, x__xgafv=None)</code> |
| <pre>Create a new CertificateAuthority in a given Project and Location. |
| |
| Args: |
| parent: string, Required. The resource name of the CaPool associated with the CertificateAuthorities, in the format `projects/*/locations/*/caPools/*`. (required) |
| body: object, The request body. |
| The object takes the form of: |
| |
| { # A CertificateAuthority represents an individual Certificate Authority. A CertificateAuthority can be used to create Certificates. |
| "accessUrls": { # URLs where a CertificateAuthority will publish content. # Output only. URLs for accessing content published by this CA, such as the CA certificate and CRLs. |
| "caCertificateAccessUrl": "A String", # The URL where this CertificateAuthority's CA certificate is published. This will only be set for CAs that have been activated. |
| "crlAccessUrls": [ # The URLs where this CertificateAuthority's CRLs are published. This will only be set for CAs that have been activated. |
| "A String", |
| ], |
| }, |
| "caCertificateDescriptions": [ # Output only. A structured description of this CertificateAuthority's CA certificate and its issuers. Ordered as self-to-root. |
| { # A CertificateDescription describes an X.509 certificate or CSR that has been issued, as an alternative to using ASN.1 / X.509. |
| "aiaIssuingCertificateUrls": [ # Describes lists of issuer CA certificate URLs that appear in the "Authority Information Access" extension in the certificate. |
| "A String", |
| ], |
| "authorityKeyId": { # A KeyId identifies a specific public key, usually by hashing the public key. # Identifies the subject_key_id of the parent certificate, per https://tools.ietf.org/html/rfc5280#section-4.2.1.1 |
| "keyId": "A String", # Optional. The value of this KeyId encoded in lowercase hexadecimal. This is most likely the 160 bit SHA-1 hash of the public key. |
| }, |
| "certFingerprint": { # A group of fingerprints for the x509 certificate. # The hash of the x.509 certificate. |
| "sha256Hash": "A String", # The SHA 256 hash, encoded in hexadecimal, of the DER x509 certificate. |
| }, |
| "crlDistributionPoints": [ # 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 |
| "A String", |
| ], |
| "publicKey": { # A PublicKey describes a public key. # The public key that corresponds to an issued certificate. |
| "format": "A String", # Required. The format of the public key. |
| "key": "A String", # Required. A public key. The padding and encoding must match with the `KeyFormat` value specified for the `format` field. |
| }, |
| "subjectDescription": { # These values describe fields in an issued X.509 certificate such as the distinguished name, subject alternative names, serial number, and lifetime. # Describes some of the values in a certificate that are related to the subject and lifetime. |
| "hexSerialNumber": "A String", # The serial number encoded in lowercase hexadecimal. |
| "lifetime": "A String", # For convenience, the actual lifetime of an issued certificate. |
| "notAfterTime": "A String", # 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. |
| "notBeforeTime": "A String", # The time at which the certificate becomes valid. |
| "subject": { # Subject describes parts of a distinguished name that, in turn, describes the subject of the certificate. # Contains distinguished name fields such as the common name, location and / organization. |
| "commonName": "A String", # The "common name" of the subject. |
| "countryCode": "A String", # The country code of the subject. |
| "locality": "A String", # The locality or city of the subject. |
| "organization": "A String", # The organization of the subject. |
| "organizationalUnit": "A String", # The organizational_unit of the subject. |
| "postalCode": "A String", # The postal code of the subject. |
| "province": "A String", # The province, territory, or regional state of the subject. |
| "streetAddress": "A String", # The street address of the subject. |
| }, |
| "subjectAltName": { # SubjectAltNames corresponds to a more modern way of listing what the asserted identity is in a certificate (i.e., compared to the "common name" in the distinguished name). # The subject alternative name fields. |
| "customSans": [ # Contains additional subject alternative name values. |
| { # An X509Extension specifies an X.509 extension, which may be used in different parts of X.509 objects like certificates, CSRs, and CRLs. |
| "critical": True or False, # Optional. Indicates whether or not this extension is critical (i.e., if the client does not know how to handle this extension, the client should consider this to be an error). |
| "objectId": { # An ObjectId specifies an object identifier (OID). These provide context and describe types in ASN.1 messages. # Required. The OID for this X.509 extension. |
| "objectIdPath": [ # Required. The parts of an OID path. The most significant parts of the path come first. |
| 42, |
| ], |
| }, |
| "value": "A String", # Required. The value of this X.509 extension. |
| }, |
| ], |
| "dnsNames": [ # Contains only valid, fully-qualified host names. |
| "A String", |
| ], |
| "emailAddresses": [ # Contains only valid RFC 2822 E-mail addresses. |
| "A String", |
| ], |
| "ipAddresses": [ # Contains only valid 32-bit IPv4 addresses or RFC 4291 IPv6 addresses. |
| "A String", |
| ], |
| "uris": [ # Contains only valid RFC 3986 URIs. |
| "A String", |
| ], |
| }, |
| }, |
| "subjectKeyId": { # A KeyId identifies a specific public key, usually by hashing the public key. # Provides a means of identifiying certificates that contain a particular public key, per https://tools.ietf.org/html/rfc5280#section-4.2.1.2. |
| "keyId": "A String", # Optional. The value of this KeyId encoded in lowercase hexadecimal. This is most likely the 160 bit SHA-1 hash of the public key. |
| }, |
| "x509Description": { # An X509Parameters is used to describe certain fields of an X.509 certificate, such as the key usage fields, fields specific to CA certificates, certificate policy extensions and custom extensions. # Describes some of the technical X.509 fields in a certificate. |
| "additionalExtensions": [ # Optional. Describes custom X.509 extensions. |
| { # An X509Extension specifies an X.509 extension, which may be used in different parts of X.509 objects like certificates, CSRs, and CRLs. |
| "critical": True or False, # Optional. Indicates whether or not this extension is critical (i.e., if the client does not know how to handle this extension, the client should consider this to be an error). |
| "objectId": { # An ObjectId specifies an object identifier (OID). These provide context and describe types in ASN.1 messages. # Required. The OID for this X.509 extension. |
| "objectIdPath": [ # Required. The parts of an OID path. The most significant parts of the path come first. |
| 42, |
| ], |
| }, |
| "value": "A String", # Required. The value of this X.509 extension. |
| }, |
| ], |
| "aiaOcspServers": [ # Optional. Describes Online Certificate Status Protocol (OCSP) endpoint addresses that appear in the "Authority Information Access" extension in the certificate. |
| "A String", |
| ], |
| "caOptions": { # Describes values that are relevant in a CA certificate. # Optional. Describes options in this X509Parameters that are relevant in a CA certificate. |
| "isCa": True or False, # 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. |
| "maxIssuerPathLength": 42, # 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. |
| }, |
| "keyUsage": { # A KeyUsage describes key usage values that may appear in an X.509 certificate. # Optional. Indicates the intended use for keys that correspond to a certificate. |
| "baseKeyUsage": { # KeyUsage.KeyUsageOptions corresponds to the key usage values described in https://tools.ietf.org/html/rfc5280#section-4.2.1.3. # Describes high-level ways in which a key may be used. |
| "certSign": True or False, # The key may be used to sign certificates. |
| "contentCommitment": True or False, # The key may be used for cryptographic commitments. Note that this may also be referred to as "non-repudiation". |
| "crlSign": True or False, # The key may be used sign certificate revocation lists. |
| "dataEncipherment": True or False, # The key may be used to encipher data. |
| "decipherOnly": True or False, # The key may be used to decipher only. |
| "digitalSignature": True or False, # The key may be used for digital signatures. |
| "encipherOnly": True or False, # The key may be used to encipher only. |
| "keyAgreement": True or False, # The key may be used in a key agreement protocol. |
| "keyEncipherment": True or False, # The key may be used to encipher other keys. |
| }, |
| "extendedKeyUsage": { # KeyUsage.ExtendedKeyUsageOptions has fields that correspond to certain common OIDs that could be specified as an extended key usage value. # Detailed scenarios in which a key may be used. |
| "clientAuth": True or False, # 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. |
| "codeSigning": True or False, # Corresponds to OID 1.3.6.1.5.5.7.3.3. Officially described as "Signing of downloadable executable code client authentication". |
| "emailProtection": True or False, # Corresponds to OID 1.3.6.1.5.5.7.3.4. Officially described as "Email protection". |
| "ocspSigning": True or False, # Corresponds to OID 1.3.6.1.5.5.7.3.9. Officially described as "Signing OCSP responses". |
| "serverAuth": True or False, # 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. |
| "timeStamping": True or False, # Corresponds to OID 1.3.6.1.5.5.7.3.8. Officially described as "Binding the hash of an object to a time". |
| }, |
| "unknownExtendedKeyUsages": [ # Used to describe extended key usages that are not listed in the KeyUsage.ExtendedKeyUsageOptions message. |
| { # An ObjectId specifies an object identifier (OID). These provide context and describe types in ASN.1 messages. |
| "objectIdPath": [ # Required. The parts of an OID path. The most significant parts of the path come first. |
| 42, |
| ], |
| }, |
| ], |
| }, |
| "policyIds": [ # Optional. Describes the X.509 certificate policy object identifiers, per https://tools.ietf.org/html/rfc5280#section-4.2.1.4. |
| { # An ObjectId specifies an object identifier (OID). These provide context and describe types in ASN.1 messages. |
| "objectIdPath": [ # Required. The parts of an OID path. The most significant parts of the path come first. |
| 42, |
| ], |
| }, |
| ], |
| }, |
| }, |
| ], |
| "config": { # A CertificateConfig describes an X.509 certificate or CSR that is to be created, as an alternative to using ASN.1. # Required. Immutable. The config used to create a self-signed X.509 certificate or CSR. |
| "publicKey": { # A PublicKey describes a public key. # Optional. The public key that corresponds to this config. This is, for example, used when issuing Certificates, but not when creating a self-signed CertificateAuthority or CertificateAuthority CSR. |
| "format": "A String", # Required. The format of the public key. |
| "key": "A String", # Required. A public key. The padding and encoding must match with the `KeyFormat` value specified for the `format` field. |
| }, |
| "subjectConfig": { # These values are used to create the distinguished name and subject alternative name fields in an X.509 certificate. # Required. Specifies some of the values in a certificate that are related to the subject. |
| "subject": { # Subject describes parts of a distinguished name that, in turn, describes the subject of the certificate. # Required. Contains distinguished name fields such as the common name, location and organization. |
| "commonName": "A String", # The "common name" of the subject. |
| "countryCode": "A String", # The country code of the subject. |
| "locality": "A String", # The locality or city of the subject. |
| "organization": "A String", # The organization of the subject. |
| "organizationalUnit": "A String", # The organizational_unit of the subject. |
| "postalCode": "A String", # The postal code of the subject. |
| "province": "A String", # The province, territory, or regional state of the subject. |
| "streetAddress": "A String", # The street address of the subject. |
| }, |
| "subjectAltName": { # SubjectAltNames corresponds to a more modern way of listing what the asserted identity is in a certificate (i.e., compared to the "common name" in the distinguished name). # Optional. The subject alternative name fields. |
| "customSans": [ # Contains additional subject alternative name values. |
| { # An X509Extension specifies an X.509 extension, which may be used in different parts of X.509 objects like certificates, CSRs, and CRLs. |
| "critical": True or False, # Optional. Indicates whether or not this extension is critical (i.e., if the client does not know how to handle this extension, the client should consider this to be an error). |
| "objectId": { # An ObjectId specifies an object identifier (OID). These provide context and describe types in ASN.1 messages. # Required. The OID for this X.509 extension. |
| "objectIdPath": [ # Required. The parts of an OID path. The most significant parts of the path come first. |
| 42, |
| ], |
| }, |
| "value": "A String", # Required. The value of this X.509 extension. |
| }, |
| ], |
| "dnsNames": [ # Contains only valid, fully-qualified host names. |
| "A String", |
| ], |
| "emailAddresses": [ # Contains only valid RFC 2822 E-mail addresses. |
| "A String", |
| ], |
| "ipAddresses": [ # Contains only valid 32-bit IPv4 addresses or RFC 4291 IPv6 addresses. |
| "A String", |
| ], |
| "uris": [ # Contains only valid RFC 3986 URIs. |
| "A String", |
| ], |
| }, |
| }, |
| "x509Config": { # An X509Parameters is used to describe certain fields of an X.509 certificate, such as the key usage fields, fields specific to CA certificates, certificate policy extensions and custom extensions. # Required. Describes how some of the technical X.509 fields in a certificate should be populated. |
| "additionalExtensions": [ # Optional. Describes custom X.509 extensions. |
| { # An X509Extension specifies an X.509 extension, which may be used in different parts of X.509 objects like certificates, CSRs, and CRLs. |
| "critical": True or False, # Optional. Indicates whether or not this extension is critical (i.e., if the client does not know how to handle this extension, the client should consider this to be an error). |
| "objectId": { # An ObjectId specifies an object identifier (OID). These provide context and describe types in ASN.1 messages. # Required. The OID for this X.509 extension. |
| "objectIdPath": [ # Required. The parts of an OID path. The most significant parts of the path come first. |
| 42, |
| ], |
| }, |
| "value": "A String", # Required. The value of this X.509 extension. |
| }, |
| ], |
| "aiaOcspServers": [ # Optional. Describes Online Certificate Status Protocol (OCSP) endpoint addresses that appear in the "Authority Information Access" extension in the certificate. |
| "A String", |
| ], |
| "caOptions": { # Describes values that are relevant in a CA certificate. # Optional. Describes options in this X509Parameters that are relevant in a CA certificate. |
| "isCa": True or False, # 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. |
| "maxIssuerPathLength": 42, # 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. |
| }, |
| "keyUsage": { # A KeyUsage describes key usage values that may appear in an X.509 certificate. # Optional. Indicates the intended use for keys that correspond to a certificate. |
| "baseKeyUsage": { # KeyUsage.KeyUsageOptions corresponds to the key usage values described in https://tools.ietf.org/html/rfc5280#section-4.2.1.3. # Describes high-level ways in which a key may be used. |
| "certSign": True or False, # The key may be used to sign certificates. |
| "contentCommitment": True or False, # The key may be used for cryptographic commitments. Note that this may also be referred to as "non-repudiation". |
| "crlSign": True or False, # The key may be used sign certificate revocation lists. |
| "dataEncipherment": True or False, # The key may be used to encipher data. |
| "decipherOnly": True or False, # The key may be used to decipher only. |
| "digitalSignature": True or False, # The key may be used for digital signatures. |
| "encipherOnly": True or False, # The key may be used to encipher only. |
| "keyAgreement": True or False, # The key may be used in a key agreement protocol. |
| "keyEncipherment": True or False, # The key may be used to encipher other keys. |
| }, |
| "extendedKeyUsage": { # KeyUsage.ExtendedKeyUsageOptions has fields that correspond to certain common OIDs that could be specified as an extended key usage value. # Detailed scenarios in which a key may be used. |
| "clientAuth": True or False, # 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. |
| "codeSigning": True or False, # Corresponds to OID 1.3.6.1.5.5.7.3.3. Officially described as "Signing of downloadable executable code client authentication". |
| "emailProtection": True or False, # Corresponds to OID 1.3.6.1.5.5.7.3.4. Officially described as "Email protection". |
| "ocspSigning": True or False, # Corresponds to OID 1.3.6.1.5.5.7.3.9. Officially described as "Signing OCSP responses". |
| "serverAuth": True or False, # 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. |
| "timeStamping": True or False, # Corresponds to OID 1.3.6.1.5.5.7.3.8. Officially described as "Binding the hash of an object to a time". |
| }, |
| "unknownExtendedKeyUsages": [ # Used to describe extended key usages that are not listed in the KeyUsage.ExtendedKeyUsageOptions message. |
| { # An ObjectId specifies an object identifier (OID). These provide context and describe types in ASN.1 messages. |
| "objectIdPath": [ # Required. The parts of an OID path. The most significant parts of the path come first. |
| 42, |
| ], |
| }, |
| ], |
| }, |
| "policyIds": [ # Optional. Describes the X.509 certificate policy object identifiers, per https://tools.ietf.org/html/rfc5280#section-4.2.1.4. |
| { # An ObjectId specifies an object identifier (OID). These provide context and describe types in ASN.1 messages. |
| "objectIdPath": [ # Required. The parts of an OID path. The most significant parts of the path come first. |
| 42, |
| ], |
| }, |
| ], |
| }, |
| }, |
| "createTime": "A String", # Output only. The time at which this CertificateAuthority was created. |
| "deleteTime": "A String", # Output only. The time at which this CertificateAuthority was soft deleted, if it is in the DELETED state. |
| "expireTime": "A String", # Output only. The time at which this CertificateAuthority will be permanently purged, if it is in the DELETED state. |
| "gcsBucket": "A String", # 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 `gs://`) or suffixes (such as `.googleapis.com`). For example, to use a bucket named `my-bucket`, you would simply specify `my-bucket`. If not specified, a managed bucket will be created. |
| "keySpec": { # A Cloud KMS key configuration that a CertificateAuthority will use. # Required. Immutable. Used when issuing certificates for this CertificateAuthority. If this CertificateAuthority is a self-signed CertificateAuthority, this key is also used to sign the self-signed CA certificate. Otherwise, it is used to sign a CSR. |
| "algorithm": "A String", # 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 `HSM`. |
| "cloudKmsKeyVersion": "A String", # The resource name for an existing Cloud KMS CryptoKeyVersion in the format `projects/*/locations/*/keyRings/*/cryptoKeys/*/cryptoKeyVersions/*`. This option enables full flexibility in the key's capabilities and properties. |
| }, |
| "labels": { # Optional. Labels with user-defined metadata. |
| "a_key": "A String", |
| }, |
| "lifetime": "A String", # Required. Immutable. The desired lifetime of the CA certificate. Used to create the "not_before_time" and "not_after_time" fields inside an X.509 certificate. |
| "name": "A String", # Output only. The resource name for this CertificateAuthority in the format `projects/*/locations/*/caPools/*/certificateAuthorities/*`. |
| "pemCaCertificates": [ # 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. |
| "A String", |
| ], |
| "state": "A String", # Output only. The State for this CertificateAuthority. |
| "subordinateConfig": { # Describes a subordinate CA's issuers. This is either a resource name to a known issuing CertificateAuthority, or a PEM issuer certificate chain. # Optional. If this is a subordinate CertificateAuthority, this field will be set with the subordinate configuration, which describes its issuers. This may be updated, but this CertificateAuthority must continue to validate. |
| "certificateAuthority": "A String", # 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 `projects/*/locations/*/caPools/*/certificateAuthorities/*`. |
| "pemIssuerChain": { # This message describes a subordinate CA's issuer certificate chain. This wrapper exists for compatibility reasons. # Required. Contains the PEM certificate chain for the issuers of this CertificateAuthority, but not pem certificate for this CA itself. |
| "pemCertificates": [ # Required. Expected to be in leaf-to-root order according to RFC 5246. |
| "A String", |
| ], |
| }, |
| }, |
| "tier": "A String", # Output only. The CaPool.Tier of the CaPool that includes this CertificateAuthority. |
| "type": "A String", # Required. Immutable. The Type of this CertificateAuthority. |
| "updateTime": "A String", # Output only. The time at which this CertificateAuthority was last updated. |
| } |
| |
| certificateAuthorityId: string, Required. It must be unique within a location and match the regular expression `[a-zA-Z0-9_-]{1,63}` |
| requestId: string, 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). |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # This resource represents a long-running operation that is the result of a network API call. |
| "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available. |
| "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation. |
| "code": 42, # The status code, which should be an enum value of google.rpc.Code. |
| "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. |
| { |
| "a_key": "", # Properties of the object. Contains field @type with type URL. |
| }, |
| ], |
| "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. |
| }, |
| "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any. |
| "a_key": "", # Properties of the object. Contains field @type with type URL. |
| }, |
| "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`. |
| "response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. |
| "a_key": "", # Properties of the object. Contains field @type with type URL. |
| }, |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="delete">delete(name, ignoreActiveCertificates=None, requestId=None, x__xgafv=None)</code> |
| <pre>Delete a CertificateAuthority. |
| |
| Args: |
| name: string, Required. The resource name for this CertificateAuthority in the format `projects/*/locations/*/caPools/*/certificateAuthorities/*`. (required) |
| ignoreActiveCertificates: boolean, Optional. This field allows the CA to be deleted even if the CA has active certs. Active certs include both unrevoked and unexpired certs. |
| requestId: string, 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). |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # This resource represents a long-running operation that is the result of a network API call. |
| "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available. |
| "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation. |
| "code": 42, # The status code, which should be an enum value of google.rpc.Code. |
| "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. |
| { |
| "a_key": "", # Properties of the object. Contains field @type with type URL. |
| }, |
| ], |
| "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. |
| }, |
| "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any. |
| "a_key": "", # Properties of the object. Contains field @type with type URL. |
| }, |
| "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`. |
| "response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. |
| "a_key": "", # Properties of the object. Contains field @type with type URL. |
| }, |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="disable">disable(name, body=None, x__xgafv=None)</code> |
| <pre>Disable a CertificateAuthority. |
| |
| Args: |
| name: string, Required. The resource name for this CertificateAuthority in the format `projects/*/locations/*/caPools/*/certificateAuthorities/*`. (required) |
| body: object, The request body. |
| The object takes the form of: |
| |
| { # Request message for CertificateAuthorityService.DisableCertificateAuthority. |
| "requestId": "A String", # 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). |
| } |
| |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # This resource represents a long-running operation that is the result of a network API call. |
| "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available. |
| "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation. |
| "code": 42, # The status code, which should be an enum value of google.rpc.Code. |
| "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. |
| { |
| "a_key": "", # Properties of the object. Contains field @type with type URL. |
| }, |
| ], |
| "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. |
| }, |
| "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any. |
| "a_key": "", # Properties of the object. Contains field @type with type URL. |
| }, |
| "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`. |
| "response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. |
| "a_key": "", # Properties of the object. Contains field @type with type URL. |
| }, |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="enable">enable(name, body=None, x__xgafv=None)</code> |
| <pre>Enable a CertificateAuthority. |
| |
| Args: |
| name: string, Required. The resource name for this CertificateAuthority in the format `projects/*/locations/*/caPools/*/certificateAuthorities/*`. (required) |
| body: object, The request body. |
| The object takes the form of: |
| |
| { # Request message for CertificateAuthorityService.EnableCertificateAuthority. |
| "requestId": "A String", # 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). |
| } |
| |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # This resource represents a long-running operation that is the result of a network API call. |
| "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available. |
| "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation. |
| "code": 42, # The status code, which should be an enum value of google.rpc.Code. |
| "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. |
| { |
| "a_key": "", # Properties of the object. Contains field @type with type URL. |
| }, |
| ], |
| "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. |
| }, |
| "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any. |
| "a_key": "", # Properties of the object. Contains field @type with type URL. |
| }, |
| "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`. |
| "response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. |
| "a_key": "", # Properties of the object. Contains field @type with type URL. |
| }, |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="fetch">fetch(name, x__xgafv=None)</code> |
| <pre>Fetch a certificate signing request (CSR) from a CertificateAuthority that is in state AWAITING_USER_ACTIVATION and is of type SUBORDINATE. The CSR must then be signed by the desired parent Certificate Authority, which could be another CertificateAuthority resource, or could be an on-prem certificate authority. See also ActivateCertificateAuthority. |
| |
| Args: |
| name: string, Required. The resource name for this CertificateAuthority in the format `projects/*/locations/*/caPools/*/certificateAuthorities/*`. (required) |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # Response message for CertificateAuthorityService.FetchCertificateAuthorityCsr. |
| "pemCsr": "A String", # Output only. The PEM-encoded signed certificate signing request (CSR). |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="get">get(name, x__xgafv=None)</code> |
| <pre>Returns a CertificateAuthority. |
| |
| Args: |
| name: string, Required. The name of the CertificateAuthority to get. (required) |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # A CertificateAuthority represents an individual Certificate Authority. A CertificateAuthority can be used to create Certificates. |
| "accessUrls": { # URLs where a CertificateAuthority will publish content. # Output only. URLs for accessing content published by this CA, such as the CA certificate and CRLs. |
| "caCertificateAccessUrl": "A String", # The URL where this CertificateAuthority's CA certificate is published. This will only be set for CAs that have been activated. |
| "crlAccessUrls": [ # The URLs where this CertificateAuthority's CRLs are published. This will only be set for CAs that have been activated. |
| "A String", |
| ], |
| }, |
| "caCertificateDescriptions": [ # Output only. A structured description of this CertificateAuthority's CA certificate and its issuers. Ordered as self-to-root. |
| { # A CertificateDescription describes an X.509 certificate or CSR that has been issued, as an alternative to using ASN.1 / X.509. |
| "aiaIssuingCertificateUrls": [ # Describes lists of issuer CA certificate URLs that appear in the "Authority Information Access" extension in the certificate. |
| "A String", |
| ], |
| "authorityKeyId": { # A KeyId identifies a specific public key, usually by hashing the public key. # Identifies the subject_key_id of the parent certificate, per https://tools.ietf.org/html/rfc5280#section-4.2.1.1 |
| "keyId": "A String", # Optional. The value of this KeyId encoded in lowercase hexadecimal. This is most likely the 160 bit SHA-1 hash of the public key. |
| }, |
| "certFingerprint": { # A group of fingerprints for the x509 certificate. # The hash of the x.509 certificate. |
| "sha256Hash": "A String", # The SHA 256 hash, encoded in hexadecimal, of the DER x509 certificate. |
| }, |
| "crlDistributionPoints": [ # 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 |
| "A String", |
| ], |
| "publicKey": { # A PublicKey describes a public key. # The public key that corresponds to an issued certificate. |
| "format": "A String", # Required. The format of the public key. |
| "key": "A String", # Required. A public key. The padding and encoding must match with the `KeyFormat` value specified for the `format` field. |
| }, |
| "subjectDescription": { # These values describe fields in an issued X.509 certificate such as the distinguished name, subject alternative names, serial number, and lifetime. # Describes some of the values in a certificate that are related to the subject and lifetime. |
| "hexSerialNumber": "A String", # The serial number encoded in lowercase hexadecimal. |
| "lifetime": "A String", # For convenience, the actual lifetime of an issued certificate. |
| "notAfterTime": "A String", # 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. |
| "notBeforeTime": "A String", # The time at which the certificate becomes valid. |
| "subject": { # Subject describes parts of a distinguished name that, in turn, describes the subject of the certificate. # Contains distinguished name fields such as the common name, location and / organization. |
| "commonName": "A String", # The "common name" of the subject. |
| "countryCode": "A String", # The country code of the subject. |
| "locality": "A String", # The locality or city of the subject. |
| "organization": "A String", # The organization of the subject. |
| "organizationalUnit": "A String", # The organizational_unit of the subject. |
| "postalCode": "A String", # The postal code of the subject. |
| "province": "A String", # The province, territory, or regional state of the subject. |
| "streetAddress": "A String", # The street address of the subject. |
| }, |
| "subjectAltName": { # SubjectAltNames corresponds to a more modern way of listing what the asserted identity is in a certificate (i.e., compared to the "common name" in the distinguished name). # The subject alternative name fields. |
| "customSans": [ # Contains additional subject alternative name values. |
| { # An X509Extension specifies an X.509 extension, which may be used in different parts of X.509 objects like certificates, CSRs, and CRLs. |
| "critical": True or False, # Optional. Indicates whether or not this extension is critical (i.e., if the client does not know how to handle this extension, the client should consider this to be an error). |
| "objectId": { # An ObjectId specifies an object identifier (OID). These provide context and describe types in ASN.1 messages. # Required. The OID for this X.509 extension. |
| "objectIdPath": [ # Required. The parts of an OID path. The most significant parts of the path come first. |
| 42, |
| ], |
| }, |
| "value": "A String", # Required. The value of this X.509 extension. |
| }, |
| ], |
| "dnsNames": [ # Contains only valid, fully-qualified host names. |
| "A String", |
| ], |
| "emailAddresses": [ # Contains only valid RFC 2822 E-mail addresses. |
| "A String", |
| ], |
| "ipAddresses": [ # Contains only valid 32-bit IPv4 addresses or RFC 4291 IPv6 addresses. |
| "A String", |
| ], |
| "uris": [ # Contains only valid RFC 3986 URIs. |
| "A String", |
| ], |
| }, |
| }, |
| "subjectKeyId": { # A KeyId identifies a specific public key, usually by hashing the public key. # Provides a means of identifiying certificates that contain a particular public key, per https://tools.ietf.org/html/rfc5280#section-4.2.1.2. |
| "keyId": "A String", # Optional. The value of this KeyId encoded in lowercase hexadecimal. This is most likely the 160 bit SHA-1 hash of the public key. |
| }, |
| "x509Description": { # An X509Parameters is used to describe certain fields of an X.509 certificate, such as the key usage fields, fields specific to CA certificates, certificate policy extensions and custom extensions. # Describes some of the technical X.509 fields in a certificate. |
| "additionalExtensions": [ # Optional. Describes custom X.509 extensions. |
| { # An X509Extension specifies an X.509 extension, which may be used in different parts of X.509 objects like certificates, CSRs, and CRLs. |
| "critical": True or False, # Optional. Indicates whether or not this extension is critical (i.e., if the client does not know how to handle this extension, the client should consider this to be an error). |
| "objectId": { # An ObjectId specifies an object identifier (OID). These provide context and describe types in ASN.1 messages. # Required. The OID for this X.509 extension. |
| "objectIdPath": [ # Required. The parts of an OID path. The most significant parts of the path come first. |
| 42, |
| ], |
| }, |
| "value": "A String", # Required. The value of this X.509 extension. |
| }, |
| ], |
| "aiaOcspServers": [ # Optional. Describes Online Certificate Status Protocol (OCSP) endpoint addresses that appear in the "Authority Information Access" extension in the certificate. |
| "A String", |
| ], |
| "caOptions": { # Describes values that are relevant in a CA certificate. # Optional. Describes options in this X509Parameters that are relevant in a CA certificate. |
| "isCa": True or False, # 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. |
| "maxIssuerPathLength": 42, # 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. |
| }, |
| "keyUsage": { # A KeyUsage describes key usage values that may appear in an X.509 certificate. # Optional. Indicates the intended use for keys that correspond to a certificate. |
| "baseKeyUsage": { # KeyUsage.KeyUsageOptions corresponds to the key usage values described in https://tools.ietf.org/html/rfc5280#section-4.2.1.3. # Describes high-level ways in which a key may be used. |
| "certSign": True or False, # The key may be used to sign certificates. |
| "contentCommitment": True or False, # The key may be used for cryptographic commitments. Note that this may also be referred to as "non-repudiation". |
| "crlSign": True or False, # The key may be used sign certificate revocation lists. |
| "dataEncipherment": True or False, # The key may be used to encipher data. |
| "decipherOnly": True or False, # The key may be used to decipher only. |
| "digitalSignature": True or False, # The key may be used for digital signatures. |
| "encipherOnly": True or False, # The key may be used to encipher only. |
| "keyAgreement": True or False, # The key may be used in a key agreement protocol. |
| "keyEncipherment": True or False, # The key may be used to encipher other keys. |
| }, |
| "extendedKeyUsage": { # KeyUsage.ExtendedKeyUsageOptions has fields that correspond to certain common OIDs that could be specified as an extended key usage value. # Detailed scenarios in which a key may be used. |
| "clientAuth": True or False, # 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. |
| "codeSigning": True or False, # Corresponds to OID 1.3.6.1.5.5.7.3.3. Officially described as "Signing of downloadable executable code client authentication". |
| "emailProtection": True or False, # Corresponds to OID 1.3.6.1.5.5.7.3.4. Officially described as "Email protection". |
| "ocspSigning": True or False, # Corresponds to OID 1.3.6.1.5.5.7.3.9. Officially described as "Signing OCSP responses". |
| "serverAuth": True or False, # 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. |
| "timeStamping": True or False, # Corresponds to OID 1.3.6.1.5.5.7.3.8. Officially described as "Binding the hash of an object to a time". |
| }, |
| "unknownExtendedKeyUsages": [ # Used to describe extended key usages that are not listed in the KeyUsage.ExtendedKeyUsageOptions message. |
| { # An ObjectId specifies an object identifier (OID). These provide context and describe types in ASN.1 messages. |
| "objectIdPath": [ # Required. The parts of an OID path. The most significant parts of the path come first. |
| 42, |
| ], |
| }, |
| ], |
| }, |
| "policyIds": [ # Optional. Describes the X.509 certificate policy object identifiers, per https://tools.ietf.org/html/rfc5280#section-4.2.1.4. |
| { # An ObjectId specifies an object identifier (OID). These provide context and describe types in ASN.1 messages. |
| "objectIdPath": [ # Required. The parts of an OID path. The most significant parts of the path come first. |
| 42, |
| ], |
| }, |
| ], |
| }, |
| }, |
| ], |
| "config": { # A CertificateConfig describes an X.509 certificate or CSR that is to be created, as an alternative to using ASN.1. # Required. Immutable. The config used to create a self-signed X.509 certificate or CSR. |
| "publicKey": { # A PublicKey describes a public key. # Optional. The public key that corresponds to this config. This is, for example, used when issuing Certificates, but not when creating a self-signed CertificateAuthority or CertificateAuthority CSR. |
| "format": "A String", # Required. The format of the public key. |
| "key": "A String", # Required. A public key. The padding and encoding must match with the `KeyFormat` value specified for the `format` field. |
| }, |
| "subjectConfig": { # These values are used to create the distinguished name and subject alternative name fields in an X.509 certificate. # Required. Specifies some of the values in a certificate that are related to the subject. |
| "subject": { # Subject describes parts of a distinguished name that, in turn, describes the subject of the certificate. # Required. Contains distinguished name fields such as the common name, location and organization. |
| "commonName": "A String", # The "common name" of the subject. |
| "countryCode": "A String", # The country code of the subject. |
| "locality": "A String", # The locality or city of the subject. |
| "organization": "A String", # The organization of the subject. |
| "organizationalUnit": "A String", # The organizational_unit of the subject. |
| "postalCode": "A String", # The postal code of the subject. |
| "province": "A String", # The province, territory, or regional state of the subject. |
| "streetAddress": "A String", # The street address of the subject. |
| }, |
| "subjectAltName": { # SubjectAltNames corresponds to a more modern way of listing what the asserted identity is in a certificate (i.e., compared to the "common name" in the distinguished name). # Optional. The subject alternative name fields. |
| "customSans": [ # Contains additional subject alternative name values. |
| { # An X509Extension specifies an X.509 extension, which may be used in different parts of X.509 objects like certificates, CSRs, and CRLs. |
| "critical": True or False, # Optional. Indicates whether or not this extension is critical (i.e., if the client does not know how to handle this extension, the client should consider this to be an error). |
| "objectId": { # An ObjectId specifies an object identifier (OID). These provide context and describe types in ASN.1 messages. # Required. The OID for this X.509 extension. |
| "objectIdPath": [ # Required. The parts of an OID path. The most significant parts of the path come first. |
| 42, |
| ], |
| }, |
| "value": "A String", # Required. The value of this X.509 extension. |
| }, |
| ], |
| "dnsNames": [ # Contains only valid, fully-qualified host names. |
| "A String", |
| ], |
| "emailAddresses": [ # Contains only valid RFC 2822 E-mail addresses. |
| "A String", |
| ], |
| "ipAddresses": [ # Contains only valid 32-bit IPv4 addresses or RFC 4291 IPv6 addresses. |
| "A String", |
| ], |
| "uris": [ # Contains only valid RFC 3986 URIs. |
| "A String", |
| ], |
| }, |
| }, |
| "x509Config": { # An X509Parameters is used to describe certain fields of an X.509 certificate, such as the key usage fields, fields specific to CA certificates, certificate policy extensions and custom extensions. # Required. Describes how some of the technical X.509 fields in a certificate should be populated. |
| "additionalExtensions": [ # Optional. Describes custom X.509 extensions. |
| { # An X509Extension specifies an X.509 extension, which may be used in different parts of X.509 objects like certificates, CSRs, and CRLs. |
| "critical": True or False, # Optional. Indicates whether or not this extension is critical (i.e., if the client does not know how to handle this extension, the client should consider this to be an error). |
| "objectId": { # An ObjectId specifies an object identifier (OID). These provide context and describe types in ASN.1 messages. # Required. The OID for this X.509 extension. |
| "objectIdPath": [ # Required. The parts of an OID path. The most significant parts of the path come first. |
| 42, |
| ], |
| }, |
| "value": "A String", # Required. The value of this X.509 extension. |
| }, |
| ], |
| "aiaOcspServers": [ # Optional. Describes Online Certificate Status Protocol (OCSP) endpoint addresses that appear in the "Authority Information Access" extension in the certificate. |
| "A String", |
| ], |
| "caOptions": { # Describes values that are relevant in a CA certificate. # Optional. Describes options in this X509Parameters that are relevant in a CA certificate. |
| "isCa": True or False, # 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. |
| "maxIssuerPathLength": 42, # 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. |
| }, |
| "keyUsage": { # A KeyUsage describes key usage values that may appear in an X.509 certificate. # Optional. Indicates the intended use for keys that correspond to a certificate. |
| "baseKeyUsage": { # KeyUsage.KeyUsageOptions corresponds to the key usage values described in https://tools.ietf.org/html/rfc5280#section-4.2.1.3. # Describes high-level ways in which a key may be used. |
| "certSign": True or False, # The key may be used to sign certificates. |
| "contentCommitment": True or False, # The key may be used for cryptographic commitments. Note that this may also be referred to as "non-repudiation". |
| "crlSign": True or False, # The key may be used sign certificate revocation lists. |
| "dataEncipherment": True or False, # The key may be used to encipher data. |
| "decipherOnly": True or False, # The key may be used to decipher only. |
| "digitalSignature": True or False, # The key may be used for digital signatures. |
| "encipherOnly": True or False, # The key may be used to encipher only. |
| "keyAgreement": True or False, # The key may be used in a key agreement protocol. |
| "keyEncipherment": True or False, # The key may be used to encipher other keys. |
| }, |
| "extendedKeyUsage": { # KeyUsage.ExtendedKeyUsageOptions has fields that correspond to certain common OIDs that could be specified as an extended key usage value. # Detailed scenarios in which a key may be used. |
| "clientAuth": True or False, # 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. |
| "codeSigning": True or False, # Corresponds to OID 1.3.6.1.5.5.7.3.3. Officially described as "Signing of downloadable executable code client authentication". |
| "emailProtection": True or False, # Corresponds to OID 1.3.6.1.5.5.7.3.4. Officially described as "Email protection". |
| "ocspSigning": True or False, # Corresponds to OID 1.3.6.1.5.5.7.3.9. Officially described as "Signing OCSP responses". |
| "serverAuth": True or False, # 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. |
| "timeStamping": True or False, # Corresponds to OID 1.3.6.1.5.5.7.3.8. Officially described as "Binding the hash of an object to a time". |
| }, |
| "unknownExtendedKeyUsages": [ # Used to describe extended key usages that are not listed in the KeyUsage.ExtendedKeyUsageOptions message. |
| { # An ObjectId specifies an object identifier (OID). These provide context and describe types in ASN.1 messages. |
| "objectIdPath": [ # Required. The parts of an OID path. The most significant parts of the path come first. |
| 42, |
| ], |
| }, |
| ], |
| }, |
| "policyIds": [ # Optional. Describes the X.509 certificate policy object identifiers, per https://tools.ietf.org/html/rfc5280#section-4.2.1.4. |
| { # An ObjectId specifies an object identifier (OID). These provide context and describe types in ASN.1 messages. |
| "objectIdPath": [ # Required. The parts of an OID path. The most significant parts of the path come first. |
| 42, |
| ], |
| }, |
| ], |
| }, |
| }, |
| "createTime": "A String", # Output only. The time at which this CertificateAuthority was created. |
| "deleteTime": "A String", # Output only. The time at which this CertificateAuthority was soft deleted, if it is in the DELETED state. |
| "expireTime": "A String", # Output only. The time at which this CertificateAuthority will be permanently purged, if it is in the DELETED state. |
| "gcsBucket": "A String", # 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 `gs://`) or suffixes (such as `.googleapis.com`). For example, to use a bucket named `my-bucket`, you would simply specify `my-bucket`. If not specified, a managed bucket will be created. |
| "keySpec": { # A Cloud KMS key configuration that a CertificateAuthority will use. # Required. Immutable. Used when issuing certificates for this CertificateAuthority. If this CertificateAuthority is a self-signed CertificateAuthority, this key is also used to sign the self-signed CA certificate. Otherwise, it is used to sign a CSR. |
| "algorithm": "A String", # 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 `HSM`. |
| "cloudKmsKeyVersion": "A String", # The resource name for an existing Cloud KMS CryptoKeyVersion in the format `projects/*/locations/*/keyRings/*/cryptoKeys/*/cryptoKeyVersions/*`. This option enables full flexibility in the key's capabilities and properties. |
| }, |
| "labels": { # Optional. Labels with user-defined metadata. |
| "a_key": "A String", |
| }, |
| "lifetime": "A String", # Required. Immutable. The desired lifetime of the CA certificate. Used to create the "not_before_time" and "not_after_time" fields inside an X.509 certificate. |
| "name": "A String", # Output only. The resource name for this CertificateAuthority in the format `projects/*/locations/*/caPools/*/certificateAuthorities/*`. |
| "pemCaCertificates": [ # 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. |
| "A String", |
| ], |
| "state": "A String", # Output only. The State for this CertificateAuthority. |
| "subordinateConfig": { # Describes a subordinate CA's issuers. This is either a resource name to a known issuing CertificateAuthority, or a PEM issuer certificate chain. # Optional. If this is a subordinate CertificateAuthority, this field will be set with the subordinate configuration, which describes its issuers. This may be updated, but this CertificateAuthority must continue to validate. |
| "certificateAuthority": "A String", # 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 `projects/*/locations/*/caPools/*/certificateAuthorities/*`. |
| "pemIssuerChain": { # This message describes a subordinate CA's issuer certificate chain. This wrapper exists for compatibility reasons. # Required. Contains the PEM certificate chain for the issuers of this CertificateAuthority, but not pem certificate for this CA itself. |
| "pemCertificates": [ # Required. Expected to be in leaf-to-root order according to RFC 5246. |
| "A String", |
| ], |
| }, |
| }, |
| "tier": "A String", # Output only. The CaPool.Tier of the CaPool that includes this CertificateAuthority. |
| "type": "A String", # Required. Immutable. The Type of this CertificateAuthority. |
| "updateTime": "A String", # Output only. The time at which this CertificateAuthority was last updated. |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="list">list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)</code> |
| <pre>Lists CertificateAuthorities. |
| |
| Args: |
| parent: string, Required. The resource name of the CaPool associated with the CertificateAuthorities, in the format `projects/*/locations/*/caPools/*`. (required) |
| filter: string, Optional. Only include resources that match the filter in the response. |
| orderBy: string, Optional. Specify how the results should be sorted. |
| pageSize: integer, Optional. Limit on the number of CertificateAuthorities to include in the response. Further CertificateAuthorities can subsequently be obtained by including the ListCertificateAuthoritiesResponse.next_page_token in a subsequent request. If unspecified, the server will pick an appropriate default. |
| pageToken: string, Optional. Pagination token, returned earlier via ListCertificateAuthoritiesResponse.next_page_token. |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # Response message for CertificateAuthorityService.ListCertificateAuthorities. |
| "certificateAuthorities": [ # The list of CertificateAuthorities. |
| { # A CertificateAuthority represents an individual Certificate Authority. A CertificateAuthority can be used to create Certificates. |
| "accessUrls": { # URLs where a CertificateAuthority will publish content. # Output only. URLs for accessing content published by this CA, such as the CA certificate and CRLs. |
| "caCertificateAccessUrl": "A String", # The URL where this CertificateAuthority's CA certificate is published. This will only be set for CAs that have been activated. |
| "crlAccessUrls": [ # The URLs where this CertificateAuthority's CRLs are published. This will only be set for CAs that have been activated. |
| "A String", |
| ], |
| }, |
| "caCertificateDescriptions": [ # Output only. A structured description of this CertificateAuthority's CA certificate and its issuers. Ordered as self-to-root. |
| { # A CertificateDescription describes an X.509 certificate or CSR that has been issued, as an alternative to using ASN.1 / X.509. |
| "aiaIssuingCertificateUrls": [ # Describes lists of issuer CA certificate URLs that appear in the "Authority Information Access" extension in the certificate. |
| "A String", |
| ], |
| "authorityKeyId": { # A KeyId identifies a specific public key, usually by hashing the public key. # Identifies the subject_key_id of the parent certificate, per https://tools.ietf.org/html/rfc5280#section-4.2.1.1 |
| "keyId": "A String", # Optional. The value of this KeyId encoded in lowercase hexadecimal. This is most likely the 160 bit SHA-1 hash of the public key. |
| }, |
| "certFingerprint": { # A group of fingerprints for the x509 certificate. # The hash of the x.509 certificate. |
| "sha256Hash": "A String", # The SHA 256 hash, encoded in hexadecimal, of the DER x509 certificate. |
| }, |
| "crlDistributionPoints": [ # 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 |
| "A String", |
| ], |
| "publicKey": { # A PublicKey describes a public key. # The public key that corresponds to an issued certificate. |
| "format": "A String", # Required. The format of the public key. |
| "key": "A String", # Required. A public key. The padding and encoding must match with the `KeyFormat` value specified for the `format` field. |
| }, |
| "subjectDescription": { # These values describe fields in an issued X.509 certificate such as the distinguished name, subject alternative names, serial number, and lifetime. # Describes some of the values in a certificate that are related to the subject and lifetime. |
| "hexSerialNumber": "A String", # The serial number encoded in lowercase hexadecimal. |
| "lifetime": "A String", # For convenience, the actual lifetime of an issued certificate. |
| "notAfterTime": "A String", # 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. |
| "notBeforeTime": "A String", # The time at which the certificate becomes valid. |
| "subject": { # Subject describes parts of a distinguished name that, in turn, describes the subject of the certificate. # Contains distinguished name fields such as the common name, location and / organization. |
| "commonName": "A String", # The "common name" of the subject. |
| "countryCode": "A String", # The country code of the subject. |
| "locality": "A String", # The locality or city of the subject. |
| "organization": "A String", # The organization of the subject. |
| "organizationalUnit": "A String", # The organizational_unit of the subject. |
| "postalCode": "A String", # The postal code of the subject. |
| "province": "A String", # The province, territory, or regional state of the subject. |
| "streetAddress": "A String", # The street address of the subject. |
| }, |
| "subjectAltName": { # SubjectAltNames corresponds to a more modern way of listing what the asserted identity is in a certificate (i.e., compared to the "common name" in the distinguished name). # The subject alternative name fields. |
| "customSans": [ # Contains additional subject alternative name values. |
| { # An X509Extension specifies an X.509 extension, which may be used in different parts of X.509 objects like certificates, CSRs, and CRLs. |
| "critical": True or False, # Optional. Indicates whether or not this extension is critical (i.e., if the client does not know how to handle this extension, the client should consider this to be an error). |
| "objectId": { # An ObjectId specifies an object identifier (OID). These provide context and describe types in ASN.1 messages. # Required. The OID for this X.509 extension. |
| "objectIdPath": [ # Required. The parts of an OID path. The most significant parts of the path come first. |
| 42, |
| ], |
| }, |
| "value": "A String", # Required. The value of this X.509 extension. |
| }, |
| ], |
| "dnsNames": [ # Contains only valid, fully-qualified host names. |
| "A String", |
| ], |
| "emailAddresses": [ # Contains only valid RFC 2822 E-mail addresses. |
| "A String", |
| ], |
| "ipAddresses": [ # Contains only valid 32-bit IPv4 addresses or RFC 4291 IPv6 addresses. |
| "A String", |
| ], |
| "uris": [ # Contains only valid RFC 3986 URIs. |
| "A String", |
| ], |
| }, |
| }, |
| "subjectKeyId": { # A KeyId identifies a specific public key, usually by hashing the public key. # Provides a means of identifiying certificates that contain a particular public key, per https://tools.ietf.org/html/rfc5280#section-4.2.1.2. |
| "keyId": "A String", # Optional. The value of this KeyId encoded in lowercase hexadecimal. This is most likely the 160 bit SHA-1 hash of the public key. |
| }, |
| "x509Description": { # An X509Parameters is used to describe certain fields of an X.509 certificate, such as the key usage fields, fields specific to CA certificates, certificate policy extensions and custom extensions. # Describes some of the technical X.509 fields in a certificate. |
| "additionalExtensions": [ # Optional. Describes custom X.509 extensions. |
| { # An X509Extension specifies an X.509 extension, which may be used in different parts of X.509 objects like certificates, CSRs, and CRLs. |
| "critical": True or False, # Optional. Indicates whether or not this extension is critical (i.e., if the client does not know how to handle this extension, the client should consider this to be an error). |
| "objectId": { # An ObjectId specifies an object identifier (OID). These provide context and describe types in ASN.1 messages. # Required. The OID for this X.509 extension. |
| "objectIdPath": [ # Required. The parts of an OID path. The most significant parts of the path come first. |
| 42, |
| ], |
| }, |
| "value": "A String", # Required. The value of this X.509 extension. |
| }, |
| ], |
| "aiaOcspServers": [ # Optional. Describes Online Certificate Status Protocol (OCSP) endpoint addresses that appear in the "Authority Information Access" extension in the certificate. |
| "A String", |
| ], |
| "caOptions": { # Describes values that are relevant in a CA certificate. # Optional. Describes options in this X509Parameters that are relevant in a CA certificate. |
| "isCa": True or False, # 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. |
| "maxIssuerPathLength": 42, # 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. |
| }, |
| "keyUsage": { # A KeyUsage describes key usage values that may appear in an X.509 certificate. # Optional. Indicates the intended use for keys that correspond to a certificate. |
| "baseKeyUsage": { # KeyUsage.KeyUsageOptions corresponds to the key usage values described in https://tools.ietf.org/html/rfc5280#section-4.2.1.3. # Describes high-level ways in which a key may be used. |
| "certSign": True or False, # The key may be used to sign certificates. |
| "contentCommitment": True or False, # The key may be used for cryptographic commitments. Note that this may also be referred to as "non-repudiation". |
| "crlSign": True or False, # The key may be used sign certificate revocation lists. |
| "dataEncipherment": True or False, # The key may be used to encipher data. |
| "decipherOnly": True or False, # The key may be used to decipher only. |
| "digitalSignature": True or False, # The key may be used for digital signatures. |
| "encipherOnly": True or False, # The key may be used to encipher only. |
| "keyAgreement": True or False, # The key may be used in a key agreement protocol. |
| "keyEncipherment": True or False, # The key may be used to encipher other keys. |
| }, |
| "extendedKeyUsage": { # KeyUsage.ExtendedKeyUsageOptions has fields that correspond to certain common OIDs that could be specified as an extended key usage value. # Detailed scenarios in which a key may be used. |
| "clientAuth": True or False, # 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. |
| "codeSigning": True or False, # Corresponds to OID 1.3.6.1.5.5.7.3.3. Officially described as "Signing of downloadable executable code client authentication". |
| "emailProtection": True or False, # Corresponds to OID 1.3.6.1.5.5.7.3.4. Officially described as "Email protection". |
| "ocspSigning": True or False, # Corresponds to OID 1.3.6.1.5.5.7.3.9. Officially described as "Signing OCSP responses". |
| "serverAuth": True or False, # 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. |
| "timeStamping": True or False, # Corresponds to OID 1.3.6.1.5.5.7.3.8. Officially described as "Binding the hash of an object to a time". |
| }, |
| "unknownExtendedKeyUsages": [ # Used to describe extended key usages that are not listed in the KeyUsage.ExtendedKeyUsageOptions message. |
| { # An ObjectId specifies an object identifier (OID). These provide context and describe types in ASN.1 messages. |
| "objectIdPath": [ # Required. The parts of an OID path. The most significant parts of the path come first. |
| 42, |
| ], |
| }, |
| ], |
| }, |
| "policyIds": [ # Optional. Describes the X.509 certificate policy object identifiers, per https://tools.ietf.org/html/rfc5280#section-4.2.1.4. |
| { # An ObjectId specifies an object identifier (OID). These provide context and describe types in ASN.1 messages. |
| "objectIdPath": [ # Required. The parts of an OID path. The most significant parts of the path come first. |
| 42, |
| ], |
| }, |
| ], |
| }, |
| }, |
| ], |
| "config": { # A CertificateConfig describes an X.509 certificate or CSR that is to be created, as an alternative to using ASN.1. # Required. Immutable. The config used to create a self-signed X.509 certificate or CSR. |
| "publicKey": { # A PublicKey describes a public key. # Optional. The public key that corresponds to this config. This is, for example, used when issuing Certificates, but not when creating a self-signed CertificateAuthority or CertificateAuthority CSR. |
| "format": "A String", # Required. The format of the public key. |
| "key": "A String", # Required. A public key. The padding and encoding must match with the `KeyFormat` value specified for the `format` field. |
| }, |
| "subjectConfig": { # These values are used to create the distinguished name and subject alternative name fields in an X.509 certificate. # Required. Specifies some of the values in a certificate that are related to the subject. |
| "subject": { # Subject describes parts of a distinguished name that, in turn, describes the subject of the certificate. # Required. Contains distinguished name fields such as the common name, location and organization. |
| "commonName": "A String", # The "common name" of the subject. |
| "countryCode": "A String", # The country code of the subject. |
| "locality": "A String", # The locality or city of the subject. |
| "organization": "A String", # The organization of the subject. |
| "organizationalUnit": "A String", # The organizational_unit of the subject. |
| "postalCode": "A String", # The postal code of the subject. |
| "province": "A String", # The province, territory, or regional state of the subject. |
| "streetAddress": "A String", # The street address of the subject. |
| }, |
| "subjectAltName": { # SubjectAltNames corresponds to a more modern way of listing what the asserted identity is in a certificate (i.e., compared to the "common name" in the distinguished name). # Optional. The subject alternative name fields. |
| "customSans": [ # Contains additional subject alternative name values. |
| { # An X509Extension specifies an X.509 extension, which may be used in different parts of X.509 objects like certificates, CSRs, and CRLs. |
| "critical": True or False, # Optional. Indicates whether or not this extension is critical (i.e., if the client does not know how to handle this extension, the client should consider this to be an error). |
| "objectId": { # An ObjectId specifies an object identifier (OID). These provide context and describe types in ASN.1 messages. # Required. The OID for this X.509 extension. |
| "objectIdPath": [ # Required. The parts of an OID path. The most significant parts of the path come first. |
| 42, |
| ], |
| }, |
| "value": "A String", # Required. The value of this X.509 extension. |
| }, |
| ], |
| "dnsNames": [ # Contains only valid, fully-qualified host names. |
| "A String", |
| ], |
| "emailAddresses": [ # Contains only valid RFC 2822 E-mail addresses. |
| "A String", |
| ], |
| "ipAddresses": [ # Contains only valid 32-bit IPv4 addresses or RFC 4291 IPv6 addresses. |
| "A String", |
| ], |
| "uris": [ # Contains only valid RFC 3986 URIs. |
| "A String", |
| ], |
| }, |
| }, |
| "x509Config": { # An X509Parameters is used to describe certain fields of an X.509 certificate, such as the key usage fields, fields specific to CA certificates, certificate policy extensions and custom extensions. # Required. Describes how some of the technical X.509 fields in a certificate should be populated. |
| "additionalExtensions": [ # Optional. Describes custom X.509 extensions. |
| { # An X509Extension specifies an X.509 extension, which may be used in different parts of X.509 objects like certificates, CSRs, and CRLs. |
| "critical": True or False, # Optional. Indicates whether or not this extension is critical (i.e., if the client does not know how to handle this extension, the client should consider this to be an error). |
| "objectId": { # An ObjectId specifies an object identifier (OID). These provide context and describe types in ASN.1 messages. # Required. The OID for this X.509 extension. |
| "objectIdPath": [ # Required. The parts of an OID path. The most significant parts of the path come first. |
| 42, |
| ], |
| }, |
| "value": "A String", # Required. The value of this X.509 extension. |
| }, |
| ], |
| "aiaOcspServers": [ # Optional. Describes Online Certificate Status Protocol (OCSP) endpoint addresses that appear in the "Authority Information Access" extension in the certificate. |
| "A String", |
| ], |
| "caOptions": { # Describes values that are relevant in a CA certificate. # Optional. Describes options in this X509Parameters that are relevant in a CA certificate. |
| "isCa": True or False, # 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. |
| "maxIssuerPathLength": 42, # 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. |
| }, |
| "keyUsage": { # A KeyUsage describes key usage values that may appear in an X.509 certificate. # Optional. Indicates the intended use for keys that correspond to a certificate. |
| "baseKeyUsage": { # KeyUsage.KeyUsageOptions corresponds to the key usage values described in https://tools.ietf.org/html/rfc5280#section-4.2.1.3. # Describes high-level ways in which a key may be used. |
| "certSign": True or False, # The key may be used to sign certificates. |
| "contentCommitment": True or False, # The key may be used for cryptographic commitments. Note that this may also be referred to as "non-repudiation". |
| "crlSign": True or False, # The key may be used sign certificate revocation lists. |
| "dataEncipherment": True or False, # The key may be used to encipher data. |
| "decipherOnly": True or False, # The key may be used to decipher only. |
| "digitalSignature": True or False, # The key may be used for digital signatures. |
| "encipherOnly": True or False, # The key may be used to encipher only. |
| "keyAgreement": True or False, # The key may be used in a key agreement protocol. |
| "keyEncipherment": True or False, # The key may be used to encipher other keys. |
| }, |
| "extendedKeyUsage": { # KeyUsage.ExtendedKeyUsageOptions has fields that correspond to certain common OIDs that could be specified as an extended key usage value. # Detailed scenarios in which a key may be used. |
| "clientAuth": True or False, # 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. |
| "codeSigning": True or False, # Corresponds to OID 1.3.6.1.5.5.7.3.3. Officially described as "Signing of downloadable executable code client authentication". |
| "emailProtection": True or False, # Corresponds to OID 1.3.6.1.5.5.7.3.4. Officially described as "Email protection". |
| "ocspSigning": True or False, # Corresponds to OID 1.3.6.1.5.5.7.3.9. Officially described as "Signing OCSP responses". |
| "serverAuth": True or False, # 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. |
| "timeStamping": True or False, # Corresponds to OID 1.3.6.1.5.5.7.3.8. Officially described as "Binding the hash of an object to a time". |
| }, |
| "unknownExtendedKeyUsages": [ # Used to describe extended key usages that are not listed in the KeyUsage.ExtendedKeyUsageOptions message. |
| { # An ObjectId specifies an object identifier (OID). These provide context and describe types in ASN.1 messages. |
| "objectIdPath": [ # Required. The parts of an OID path. The most significant parts of the path come first. |
| 42, |
| ], |
| }, |
| ], |
| }, |
| "policyIds": [ # Optional. Describes the X.509 certificate policy object identifiers, per https://tools.ietf.org/html/rfc5280#section-4.2.1.4. |
| { # An ObjectId specifies an object identifier (OID). These provide context and describe types in ASN.1 messages. |
| "objectIdPath": [ # Required. The parts of an OID path. The most significant parts of the path come first. |
| 42, |
| ], |
| }, |
| ], |
| }, |
| }, |
| "createTime": "A String", # Output only. The time at which this CertificateAuthority was created. |
| "deleteTime": "A String", # Output only. The time at which this CertificateAuthority was soft deleted, if it is in the DELETED state. |
| "expireTime": "A String", # Output only. The time at which this CertificateAuthority will be permanently purged, if it is in the DELETED state. |
| "gcsBucket": "A String", # 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 `gs://`) or suffixes (such as `.googleapis.com`). For example, to use a bucket named `my-bucket`, you would simply specify `my-bucket`. If not specified, a managed bucket will be created. |
| "keySpec": { # A Cloud KMS key configuration that a CertificateAuthority will use. # Required. Immutable. Used when issuing certificates for this CertificateAuthority. If this CertificateAuthority is a self-signed CertificateAuthority, this key is also used to sign the self-signed CA certificate. Otherwise, it is used to sign a CSR. |
| "algorithm": "A String", # 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 `HSM`. |
| "cloudKmsKeyVersion": "A String", # The resource name for an existing Cloud KMS CryptoKeyVersion in the format `projects/*/locations/*/keyRings/*/cryptoKeys/*/cryptoKeyVersions/*`. This option enables full flexibility in the key's capabilities and properties. |
| }, |
| "labels": { # Optional. Labels with user-defined metadata. |
| "a_key": "A String", |
| }, |
| "lifetime": "A String", # Required. Immutable. The desired lifetime of the CA certificate. Used to create the "not_before_time" and "not_after_time" fields inside an X.509 certificate. |
| "name": "A String", # Output only. The resource name for this CertificateAuthority in the format `projects/*/locations/*/caPools/*/certificateAuthorities/*`. |
| "pemCaCertificates": [ # 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. |
| "A String", |
| ], |
| "state": "A String", # Output only. The State for this CertificateAuthority. |
| "subordinateConfig": { # Describes a subordinate CA's issuers. This is either a resource name to a known issuing CertificateAuthority, or a PEM issuer certificate chain. # Optional. If this is a subordinate CertificateAuthority, this field will be set with the subordinate configuration, which describes its issuers. This may be updated, but this CertificateAuthority must continue to validate. |
| "certificateAuthority": "A String", # 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 `projects/*/locations/*/caPools/*/certificateAuthorities/*`. |
| "pemIssuerChain": { # This message describes a subordinate CA's issuer certificate chain. This wrapper exists for compatibility reasons. # Required. Contains the PEM certificate chain for the issuers of this CertificateAuthority, but not pem certificate for this CA itself. |
| "pemCertificates": [ # Required. Expected to be in leaf-to-root order according to RFC 5246. |
| "A String", |
| ], |
| }, |
| }, |
| "tier": "A String", # Output only. The CaPool.Tier of the CaPool that includes this CertificateAuthority. |
| "type": "A String", # Required. Immutable. The Type of this CertificateAuthority. |
| "updateTime": "A String", # Output only. The time at which this CertificateAuthority was last updated. |
| }, |
| ], |
| "nextPageToken": "A String", # A token to retrieve next page of results. Pass this value in ListCertificateAuthoritiesRequest.next_page_token to retrieve the next page of results. |
| "unreachable": [ # A list of locations (e.g. "us-west1") that could not be reached. |
| "A String", |
| ], |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="list_next">list_next(previous_request, previous_response)</code> |
| <pre>Retrieves the next page of results. |
| |
| Args: |
| previous_request: The request for the previous page. (required) |
| previous_response: The response from the request for the previous page. (required) |
| |
| Returns: |
| A request object that you can call 'execute()' on to request the next |
| page. Returns None if there are no more items in the collection. |
| </pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="patch">patch(name, body=None, requestId=None, updateMask=None, x__xgafv=None)</code> |
| <pre>Update a CertificateAuthority. |
| |
| Args: |
| name: string, Output only. The resource name for this CertificateAuthority in the format `projects/*/locations/*/caPools/*/certificateAuthorities/*`. (required) |
| body: object, The request body. |
| The object takes the form of: |
| |
| { # A CertificateAuthority represents an individual Certificate Authority. A CertificateAuthority can be used to create Certificates. |
| "accessUrls": { # URLs where a CertificateAuthority will publish content. # Output only. URLs for accessing content published by this CA, such as the CA certificate and CRLs. |
| "caCertificateAccessUrl": "A String", # The URL where this CertificateAuthority's CA certificate is published. This will only be set for CAs that have been activated. |
| "crlAccessUrls": [ # The URLs where this CertificateAuthority's CRLs are published. This will only be set for CAs that have been activated. |
| "A String", |
| ], |
| }, |
| "caCertificateDescriptions": [ # Output only. A structured description of this CertificateAuthority's CA certificate and its issuers. Ordered as self-to-root. |
| { # A CertificateDescription describes an X.509 certificate or CSR that has been issued, as an alternative to using ASN.1 / X.509. |
| "aiaIssuingCertificateUrls": [ # Describes lists of issuer CA certificate URLs that appear in the "Authority Information Access" extension in the certificate. |
| "A String", |
| ], |
| "authorityKeyId": { # A KeyId identifies a specific public key, usually by hashing the public key. # Identifies the subject_key_id of the parent certificate, per https://tools.ietf.org/html/rfc5280#section-4.2.1.1 |
| "keyId": "A String", # Optional. The value of this KeyId encoded in lowercase hexadecimal. This is most likely the 160 bit SHA-1 hash of the public key. |
| }, |
| "certFingerprint": { # A group of fingerprints for the x509 certificate. # The hash of the x.509 certificate. |
| "sha256Hash": "A String", # The SHA 256 hash, encoded in hexadecimal, of the DER x509 certificate. |
| }, |
| "crlDistributionPoints": [ # 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 |
| "A String", |
| ], |
| "publicKey": { # A PublicKey describes a public key. # The public key that corresponds to an issued certificate. |
| "format": "A String", # Required. The format of the public key. |
| "key": "A String", # Required. A public key. The padding and encoding must match with the `KeyFormat` value specified for the `format` field. |
| }, |
| "subjectDescription": { # These values describe fields in an issued X.509 certificate such as the distinguished name, subject alternative names, serial number, and lifetime. # Describes some of the values in a certificate that are related to the subject and lifetime. |
| "hexSerialNumber": "A String", # The serial number encoded in lowercase hexadecimal. |
| "lifetime": "A String", # For convenience, the actual lifetime of an issued certificate. |
| "notAfterTime": "A String", # 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. |
| "notBeforeTime": "A String", # The time at which the certificate becomes valid. |
| "subject": { # Subject describes parts of a distinguished name that, in turn, describes the subject of the certificate. # Contains distinguished name fields such as the common name, location and / organization. |
| "commonName": "A String", # The "common name" of the subject. |
| "countryCode": "A String", # The country code of the subject. |
| "locality": "A String", # The locality or city of the subject. |
| "organization": "A String", # The organization of the subject. |
| "organizationalUnit": "A String", # The organizational_unit of the subject. |
| "postalCode": "A String", # The postal code of the subject. |
| "province": "A String", # The province, territory, or regional state of the subject. |
| "streetAddress": "A String", # The street address of the subject. |
| }, |
| "subjectAltName": { # SubjectAltNames corresponds to a more modern way of listing what the asserted identity is in a certificate (i.e., compared to the "common name" in the distinguished name). # The subject alternative name fields. |
| "customSans": [ # Contains additional subject alternative name values. |
| { # An X509Extension specifies an X.509 extension, which may be used in different parts of X.509 objects like certificates, CSRs, and CRLs. |
| "critical": True or False, # Optional. Indicates whether or not this extension is critical (i.e., if the client does not know how to handle this extension, the client should consider this to be an error). |
| "objectId": { # An ObjectId specifies an object identifier (OID). These provide context and describe types in ASN.1 messages. # Required. The OID for this X.509 extension. |
| "objectIdPath": [ # Required. The parts of an OID path. The most significant parts of the path come first. |
| 42, |
| ], |
| }, |
| "value": "A String", # Required. The value of this X.509 extension. |
| }, |
| ], |
| "dnsNames": [ # Contains only valid, fully-qualified host names. |
| "A String", |
| ], |
| "emailAddresses": [ # Contains only valid RFC 2822 E-mail addresses. |
| "A String", |
| ], |
| "ipAddresses": [ # Contains only valid 32-bit IPv4 addresses or RFC 4291 IPv6 addresses. |
| "A String", |
| ], |
| "uris": [ # Contains only valid RFC 3986 URIs. |
| "A String", |
| ], |
| }, |
| }, |
| "subjectKeyId": { # A KeyId identifies a specific public key, usually by hashing the public key. # Provides a means of identifiying certificates that contain a particular public key, per https://tools.ietf.org/html/rfc5280#section-4.2.1.2. |
| "keyId": "A String", # Optional. The value of this KeyId encoded in lowercase hexadecimal. This is most likely the 160 bit SHA-1 hash of the public key. |
| }, |
| "x509Description": { # An X509Parameters is used to describe certain fields of an X.509 certificate, such as the key usage fields, fields specific to CA certificates, certificate policy extensions and custom extensions. # Describes some of the technical X.509 fields in a certificate. |
| "additionalExtensions": [ # Optional. Describes custom X.509 extensions. |
| { # An X509Extension specifies an X.509 extension, which may be used in different parts of X.509 objects like certificates, CSRs, and CRLs. |
| "critical": True or False, # Optional. Indicates whether or not this extension is critical (i.e., if the client does not know how to handle this extension, the client should consider this to be an error). |
| "objectId": { # An ObjectId specifies an object identifier (OID). These provide context and describe types in ASN.1 messages. # Required. The OID for this X.509 extension. |
| "objectIdPath": [ # Required. The parts of an OID path. The most significant parts of the path come first. |
| 42, |
| ], |
| }, |
| "value": "A String", # Required. The value of this X.509 extension. |
| }, |
| ], |
| "aiaOcspServers": [ # Optional. Describes Online Certificate Status Protocol (OCSP) endpoint addresses that appear in the "Authority Information Access" extension in the certificate. |
| "A String", |
| ], |
| "caOptions": { # Describes values that are relevant in a CA certificate. # Optional. Describes options in this X509Parameters that are relevant in a CA certificate. |
| "isCa": True or False, # 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. |
| "maxIssuerPathLength": 42, # 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. |
| }, |
| "keyUsage": { # A KeyUsage describes key usage values that may appear in an X.509 certificate. # Optional. Indicates the intended use for keys that correspond to a certificate. |
| "baseKeyUsage": { # KeyUsage.KeyUsageOptions corresponds to the key usage values described in https://tools.ietf.org/html/rfc5280#section-4.2.1.3. # Describes high-level ways in which a key may be used. |
| "certSign": True or False, # The key may be used to sign certificates. |
| "contentCommitment": True or False, # The key may be used for cryptographic commitments. Note that this may also be referred to as "non-repudiation". |
| "crlSign": True or False, # The key may be used sign certificate revocation lists. |
| "dataEncipherment": True or False, # The key may be used to encipher data. |
| "decipherOnly": True or False, # The key may be used to decipher only. |
| "digitalSignature": True or False, # The key may be used for digital signatures. |
| "encipherOnly": True or False, # The key may be used to encipher only. |
| "keyAgreement": True or False, # The key may be used in a key agreement protocol. |
| "keyEncipherment": True or False, # The key may be used to encipher other keys. |
| }, |
| "extendedKeyUsage": { # KeyUsage.ExtendedKeyUsageOptions has fields that correspond to certain common OIDs that could be specified as an extended key usage value. # Detailed scenarios in which a key may be used. |
| "clientAuth": True or False, # 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. |
| "codeSigning": True or False, # Corresponds to OID 1.3.6.1.5.5.7.3.3. Officially described as "Signing of downloadable executable code client authentication". |
| "emailProtection": True or False, # Corresponds to OID 1.3.6.1.5.5.7.3.4. Officially described as "Email protection". |
| "ocspSigning": True or False, # Corresponds to OID 1.3.6.1.5.5.7.3.9. Officially described as "Signing OCSP responses". |
| "serverAuth": True or False, # 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. |
| "timeStamping": True or False, # Corresponds to OID 1.3.6.1.5.5.7.3.8. Officially described as "Binding the hash of an object to a time". |
| }, |
| "unknownExtendedKeyUsages": [ # Used to describe extended key usages that are not listed in the KeyUsage.ExtendedKeyUsageOptions message. |
| { # An ObjectId specifies an object identifier (OID). These provide context and describe types in ASN.1 messages. |
| "objectIdPath": [ # Required. The parts of an OID path. The most significant parts of the path come first. |
| 42, |
| ], |
| }, |
| ], |
| }, |
| "policyIds": [ # Optional. Describes the X.509 certificate policy object identifiers, per https://tools.ietf.org/html/rfc5280#section-4.2.1.4. |
| { # An ObjectId specifies an object identifier (OID). These provide context and describe types in ASN.1 messages. |
| "objectIdPath": [ # Required. The parts of an OID path. The most significant parts of the path come first. |
| 42, |
| ], |
| }, |
| ], |
| }, |
| }, |
| ], |
| "config": { # A CertificateConfig describes an X.509 certificate or CSR that is to be created, as an alternative to using ASN.1. # Required. Immutable. The config used to create a self-signed X.509 certificate or CSR. |
| "publicKey": { # A PublicKey describes a public key. # Optional. The public key that corresponds to this config. This is, for example, used when issuing Certificates, but not when creating a self-signed CertificateAuthority or CertificateAuthority CSR. |
| "format": "A String", # Required. The format of the public key. |
| "key": "A String", # Required. A public key. The padding and encoding must match with the `KeyFormat` value specified for the `format` field. |
| }, |
| "subjectConfig": { # These values are used to create the distinguished name and subject alternative name fields in an X.509 certificate. # Required. Specifies some of the values in a certificate that are related to the subject. |
| "subject": { # Subject describes parts of a distinguished name that, in turn, describes the subject of the certificate. # Required. Contains distinguished name fields such as the common name, location and organization. |
| "commonName": "A String", # The "common name" of the subject. |
| "countryCode": "A String", # The country code of the subject. |
| "locality": "A String", # The locality or city of the subject. |
| "organization": "A String", # The organization of the subject. |
| "organizationalUnit": "A String", # The organizational_unit of the subject. |
| "postalCode": "A String", # The postal code of the subject. |
| "province": "A String", # The province, territory, or regional state of the subject. |
| "streetAddress": "A String", # The street address of the subject. |
| }, |
| "subjectAltName": { # SubjectAltNames corresponds to a more modern way of listing what the asserted identity is in a certificate (i.e., compared to the "common name" in the distinguished name). # Optional. The subject alternative name fields. |
| "customSans": [ # Contains additional subject alternative name values. |
| { # An X509Extension specifies an X.509 extension, which may be used in different parts of X.509 objects like certificates, CSRs, and CRLs. |
| "critical": True or False, # Optional. Indicates whether or not this extension is critical (i.e., if the client does not know how to handle this extension, the client should consider this to be an error). |
| "objectId": { # An ObjectId specifies an object identifier (OID). These provide context and describe types in ASN.1 messages. # Required. The OID for this X.509 extension. |
| "objectIdPath": [ # Required. The parts of an OID path. The most significant parts of the path come first. |
| 42, |
| ], |
| }, |
| "value": "A String", # Required. The value of this X.509 extension. |
| }, |
| ], |
| "dnsNames": [ # Contains only valid, fully-qualified host names. |
| "A String", |
| ], |
| "emailAddresses": [ # Contains only valid RFC 2822 E-mail addresses. |
| "A String", |
| ], |
| "ipAddresses": [ # Contains only valid 32-bit IPv4 addresses or RFC 4291 IPv6 addresses. |
| "A String", |
| ], |
| "uris": [ # Contains only valid RFC 3986 URIs. |
| "A String", |
| ], |
| }, |
| }, |
| "x509Config": { # An X509Parameters is used to describe certain fields of an X.509 certificate, such as the key usage fields, fields specific to CA certificates, certificate policy extensions and custom extensions. # Required. Describes how some of the technical X.509 fields in a certificate should be populated. |
| "additionalExtensions": [ # Optional. Describes custom X.509 extensions. |
| { # An X509Extension specifies an X.509 extension, which may be used in different parts of X.509 objects like certificates, CSRs, and CRLs. |
| "critical": True or False, # Optional. Indicates whether or not this extension is critical (i.e., if the client does not know how to handle this extension, the client should consider this to be an error). |
| "objectId": { # An ObjectId specifies an object identifier (OID). These provide context and describe types in ASN.1 messages. # Required. The OID for this X.509 extension. |
| "objectIdPath": [ # Required. The parts of an OID path. The most significant parts of the path come first. |
| 42, |
| ], |
| }, |
| "value": "A String", # Required. The value of this X.509 extension. |
| }, |
| ], |
| "aiaOcspServers": [ # Optional. Describes Online Certificate Status Protocol (OCSP) endpoint addresses that appear in the "Authority Information Access" extension in the certificate. |
| "A String", |
| ], |
| "caOptions": { # Describes values that are relevant in a CA certificate. # Optional. Describes options in this X509Parameters that are relevant in a CA certificate. |
| "isCa": True or False, # 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. |
| "maxIssuerPathLength": 42, # 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. |
| }, |
| "keyUsage": { # A KeyUsage describes key usage values that may appear in an X.509 certificate. # Optional. Indicates the intended use for keys that correspond to a certificate. |
| "baseKeyUsage": { # KeyUsage.KeyUsageOptions corresponds to the key usage values described in https://tools.ietf.org/html/rfc5280#section-4.2.1.3. # Describes high-level ways in which a key may be used. |
| "certSign": True or False, # The key may be used to sign certificates. |
| "contentCommitment": True or False, # The key may be used for cryptographic commitments. Note that this may also be referred to as "non-repudiation". |
| "crlSign": True or False, # The key may be used sign certificate revocation lists. |
| "dataEncipherment": True or False, # The key may be used to encipher data. |
| "decipherOnly": True or False, # The key may be used to decipher only. |
| "digitalSignature": True or False, # The key may be used for digital signatures. |
| "encipherOnly": True or False, # The key may be used to encipher only. |
| "keyAgreement": True or False, # The key may be used in a key agreement protocol. |
| "keyEncipherment": True or False, # The key may be used to encipher other keys. |
| }, |
| "extendedKeyUsage": { # KeyUsage.ExtendedKeyUsageOptions has fields that correspond to certain common OIDs that could be specified as an extended key usage value. # Detailed scenarios in which a key may be used. |
| "clientAuth": True or False, # 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. |
| "codeSigning": True or False, # Corresponds to OID 1.3.6.1.5.5.7.3.3. Officially described as "Signing of downloadable executable code client authentication". |
| "emailProtection": True or False, # Corresponds to OID 1.3.6.1.5.5.7.3.4. Officially described as "Email protection". |
| "ocspSigning": True or False, # Corresponds to OID 1.3.6.1.5.5.7.3.9. Officially described as "Signing OCSP responses". |
| "serverAuth": True or False, # 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. |
| "timeStamping": True or False, # Corresponds to OID 1.3.6.1.5.5.7.3.8. Officially described as "Binding the hash of an object to a time". |
| }, |
| "unknownExtendedKeyUsages": [ # Used to describe extended key usages that are not listed in the KeyUsage.ExtendedKeyUsageOptions message. |
| { # An ObjectId specifies an object identifier (OID). These provide context and describe types in ASN.1 messages. |
| "objectIdPath": [ # Required. The parts of an OID path. The most significant parts of the path come first. |
| 42, |
| ], |
| }, |
| ], |
| }, |
| "policyIds": [ # Optional. Describes the X.509 certificate policy object identifiers, per https://tools.ietf.org/html/rfc5280#section-4.2.1.4. |
| { # An ObjectId specifies an object identifier (OID). These provide context and describe types in ASN.1 messages. |
| "objectIdPath": [ # Required. The parts of an OID path. The most significant parts of the path come first. |
| 42, |
| ], |
| }, |
| ], |
| }, |
| }, |
| "createTime": "A String", # Output only. The time at which this CertificateAuthority was created. |
| "deleteTime": "A String", # Output only. The time at which this CertificateAuthority was soft deleted, if it is in the DELETED state. |
| "expireTime": "A String", # Output only. The time at which this CertificateAuthority will be permanently purged, if it is in the DELETED state. |
| "gcsBucket": "A String", # 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 `gs://`) or suffixes (such as `.googleapis.com`). For example, to use a bucket named `my-bucket`, you would simply specify `my-bucket`. If not specified, a managed bucket will be created. |
| "keySpec": { # A Cloud KMS key configuration that a CertificateAuthority will use. # Required. Immutable. Used when issuing certificates for this CertificateAuthority. If this CertificateAuthority is a self-signed CertificateAuthority, this key is also used to sign the self-signed CA certificate. Otherwise, it is used to sign a CSR. |
| "algorithm": "A String", # 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 `HSM`. |
| "cloudKmsKeyVersion": "A String", # The resource name for an existing Cloud KMS CryptoKeyVersion in the format `projects/*/locations/*/keyRings/*/cryptoKeys/*/cryptoKeyVersions/*`. This option enables full flexibility in the key's capabilities and properties. |
| }, |
| "labels": { # Optional. Labels with user-defined metadata. |
| "a_key": "A String", |
| }, |
| "lifetime": "A String", # Required. Immutable. The desired lifetime of the CA certificate. Used to create the "not_before_time" and "not_after_time" fields inside an X.509 certificate. |
| "name": "A String", # Output only. The resource name for this CertificateAuthority in the format `projects/*/locations/*/caPools/*/certificateAuthorities/*`. |
| "pemCaCertificates": [ # 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. |
| "A String", |
| ], |
| "state": "A String", # Output only. The State for this CertificateAuthority. |
| "subordinateConfig": { # Describes a subordinate CA's issuers. This is either a resource name to a known issuing CertificateAuthority, or a PEM issuer certificate chain. # Optional. If this is a subordinate CertificateAuthority, this field will be set with the subordinate configuration, which describes its issuers. This may be updated, but this CertificateAuthority must continue to validate. |
| "certificateAuthority": "A String", # 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 `projects/*/locations/*/caPools/*/certificateAuthorities/*`. |
| "pemIssuerChain": { # This message describes a subordinate CA's issuer certificate chain. This wrapper exists for compatibility reasons. # Required. Contains the PEM certificate chain for the issuers of this CertificateAuthority, but not pem certificate for this CA itself. |
| "pemCertificates": [ # Required. Expected to be in leaf-to-root order according to RFC 5246. |
| "A String", |
| ], |
| }, |
| }, |
| "tier": "A String", # Output only. The CaPool.Tier of the CaPool that includes this CertificateAuthority. |
| "type": "A String", # Required. Immutable. The Type of this CertificateAuthority. |
| "updateTime": "A String", # Output only. The time at which this CertificateAuthority was last updated. |
| } |
| |
| requestId: string, 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). |
| updateMask: string, Required. A list of fields to be updated in this request. |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # This resource represents a long-running operation that is the result of a network API call. |
| "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available. |
| "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation. |
| "code": 42, # The status code, which should be an enum value of google.rpc.Code. |
| "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. |
| { |
| "a_key": "", # Properties of the object. Contains field @type with type URL. |
| }, |
| ], |
| "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. |
| }, |
| "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any. |
| "a_key": "", # Properties of the object. Contains field @type with type URL. |
| }, |
| "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`. |
| "response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. |
| "a_key": "", # Properties of the object. Contains field @type with type URL. |
| }, |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="undelete">undelete(name, body=None, x__xgafv=None)</code> |
| <pre>Undelete a CertificateAuthority that has been deleted. |
| |
| Args: |
| name: string, Required. The resource name for this CertificateAuthority in the format `projects/*/locations/*/caPools/*/certificateAuthorities/*`. (required) |
| body: object, The request body. |
| The object takes the form of: |
| |
| { # Request message for CertificateAuthorityService.UndeleteCertificateAuthority. |
| "requestId": "A String", # 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). |
| } |
| |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # This resource represents a long-running operation that is the result of a network API call. |
| "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available. |
| "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation. |
| "code": 42, # The status code, which should be an enum value of google.rpc.Code. |
| "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. |
| { |
| "a_key": "", # Properties of the object. Contains field @type with type URL. |
| }, |
| ], |
| "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. |
| }, |
| "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any. |
| "a_key": "", # Properties of the object. Contains field @type with type URL. |
| }, |
| "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`. |
| "response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. |
| "a_key": "", # Properties of the object. Contains field @type with type URL. |
| }, |
| }</pre> |
| </div> |
| |
| </body></html> |
