| <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="certificatemanager_v1.html">Certificate Manager API</a> . <a href="certificatemanager_v1.projects.html">projects</a> . <a href="certificatemanager_v1.projects.locations.html">locations</a> . <a href="certificatemanager_v1.projects.locations.certificates.html">certificates</a></h1> |
| <h2>Instance Methods</h2> |
| <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, certificateId=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Creates a new Certificate in a given project and location.</p> |
| <p class="toc_element"> |
| <code><a href="#delete">delete(name, x__xgafv=None)</a></code></p> |
| <p class="firstline">Deletes a single Certificate.</p> |
| <p class="toc_element"> |
| <code><a href="#get">get(name, x__xgafv=None)</a></code></p> |
| <p class="firstline">Gets details of a single Certificate.</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 Certificates in a given project and location.</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, updateMask=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Updates a Certificate.</p> |
| <h3>Method Details</h3> |
| <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, certificateId=None, x__xgafv=None)</code> |
| <pre>Creates a new Certificate in a given project and location. |
| |
| Args: |
| parent: string, Required. The parent resource of the certificate. Must be in the format `projects/*/locations/*`. (required) |
| body: object, The request body. |
| The object takes the form of: |
| |
| { # Defines TLS certificate. |
| "createTime": "A String", # Output only. The creation timestamp of a Certificate. |
| "description": "A String", # One or more paragraphs of text description of a certificate. |
| "expireTime": "A String", # Output only. The expiry timestamp of a Certificate. |
| "labels": { # Set of labels associated with a Certificate. |
| "a_key": "A String", |
| }, |
| "managed": { # Configuration and state of a Managed Certificate. Certificate Manager provisions and renews Managed Certificates automatically, for as long as it's authorized to do so. # If set, contains configuration and state of a managed certificate. |
| "authorizationAttemptInfo": [ # Output only. Detailed state of the latest authorization attempt for each domain specified for managed certificate resource. |
| { # State of the latest attempt to authorize a domain for certificate issuance. |
| "details": "A String", # Human readable explanation for reaching the state. Provided to help address the configuration issues. Not guaranteed to be stable. For programmatic access use Reason enum. |
| "domain": "A String", # Domain name of the authorization attempt. |
| "failureReason": "A String", # Output only. Reason for failure of the authorization attempt for the domain. |
| "state": "A String", # State of the domain for managed certificate issuance. |
| }, |
| ], |
| "dnsAuthorizations": [ # Immutable. Authorizations that will be used for performing domain authorization. |
| "A String", |
| ], |
| "domains": [ # Immutable. The domains for which a managed SSL certificate will be generated. Wildcard domains are only supported with DNS challenge resolution. |
| "A String", |
| ], |
| "provisioningIssue": { # Information about issues with provisioning a Managed Certificate. # Information about issues with provisioning a Managed Certificate. |
| "details": "A String", # Human readable explanation about the issue. Provided to help address the configuration issues. Not guaranteed to be stable. For programmatic access use Reason enum. |
| "reason": "A String", # Reason for provisioning failures. |
| }, |
| "state": "A String", # Output only. State of the managed certificate resource. |
| }, |
| "name": "A String", # A user-defined name of the certificate. Certificate names must be unique globally and match pattern `projects/*/locations/*/certificates/*`. |
| "pemCertificate": "A String", # Output only. The PEM-encoded certificate chain. |
| "sanDnsnames": [ # Output only. The list of Subject Alternative Names of dnsName type defined in the certificate (see RFC 5280 4.2.1.6) |
| "A String", |
| ], |
| "scope": "A String", # Immutable. The scope of the certificate. |
| "selfManaged": { # Certificate data for a SelfManaged Certificate. SelfManaged Certificates are uploaded by the user. Updating such certificates before they expire remains the user's responsibility. # If set, defines data of a self-managed certificate. |
| "pemCertificate": "A String", # Input only. The PEM-encoded certificate chain. Leaf certificate comes first, followed by intermediate ones if any. |
| "pemPrivateKey": "A String", # Input only. The PEM-encoded private key of the leaf certificate. |
| }, |
| "updateTime": "A String", # Output only. The last update timestamp of a Certificate. |
| } |
| |
| certificateId: string, Required. A user-provided name of the certificate. |
| 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, x__xgafv=None)</code> |
| <pre>Deletes a single Certificate. |
| |
| Args: |
| name: string, Required. A name of the certificate to delete. Must be in the format `projects/*/locations/*/certificates/*`. (required) |
| 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="get">get(name, x__xgafv=None)</code> |
| <pre>Gets details of a single Certificate. |
| |
| Args: |
| name: string, Required. A name of the certificate to describe. Must be in the format `projects/*/locations/*/certificates/*`. (required) |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # Defines TLS certificate. |
| "createTime": "A String", # Output only. The creation timestamp of a Certificate. |
| "description": "A String", # One or more paragraphs of text description of a certificate. |
| "expireTime": "A String", # Output only. The expiry timestamp of a Certificate. |
| "labels": { # Set of labels associated with a Certificate. |
| "a_key": "A String", |
| }, |
| "managed": { # Configuration and state of a Managed Certificate. Certificate Manager provisions and renews Managed Certificates automatically, for as long as it's authorized to do so. # If set, contains configuration and state of a managed certificate. |
| "authorizationAttemptInfo": [ # Output only. Detailed state of the latest authorization attempt for each domain specified for managed certificate resource. |
| { # State of the latest attempt to authorize a domain for certificate issuance. |
| "details": "A String", # Human readable explanation for reaching the state. Provided to help address the configuration issues. Not guaranteed to be stable. For programmatic access use Reason enum. |
| "domain": "A String", # Domain name of the authorization attempt. |
| "failureReason": "A String", # Output only. Reason for failure of the authorization attempt for the domain. |
| "state": "A String", # State of the domain for managed certificate issuance. |
| }, |
| ], |
| "dnsAuthorizations": [ # Immutable. Authorizations that will be used for performing domain authorization. |
| "A String", |
| ], |
| "domains": [ # Immutable. The domains for which a managed SSL certificate will be generated. Wildcard domains are only supported with DNS challenge resolution. |
| "A String", |
| ], |
| "provisioningIssue": { # Information about issues with provisioning a Managed Certificate. # Information about issues with provisioning a Managed Certificate. |
| "details": "A String", # Human readable explanation about the issue. Provided to help address the configuration issues. Not guaranteed to be stable. For programmatic access use Reason enum. |
| "reason": "A String", # Reason for provisioning failures. |
| }, |
| "state": "A String", # Output only. State of the managed certificate resource. |
| }, |
| "name": "A String", # A user-defined name of the certificate. Certificate names must be unique globally and match pattern `projects/*/locations/*/certificates/*`. |
| "pemCertificate": "A String", # Output only. The PEM-encoded certificate chain. |
| "sanDnsnames": [ # Output only. The list of Subject Alternative Names of dnsName type defined in the certificate (see RFC 5280 4.2.1.6) |
| "A String", |
| ], |
| "scope": "A String", # Immutable. The scope of the certificate. |
| "selfManaged": { # Certificate data for a SelfManaged Certificate. SelfManaged Certificates are uploaded by the user. Updating such certificates before they expire remains the user's responsibility. # If set, defines data of a self-managed certificate. |
| "pemCertificate": "A String", # Input only. The PEM-encoded certificate chain. Leaf certificate comes first, followed by intermediate ones if any. |
| "pemPrivateKey": "A String", # Input only. The PEM-encoded private key of the leaf certificate. |
| }, |
| "updateTime": "A String", # Output only. The last update timestamp of a Certificate. |
| }</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 Certificates in a given project and location. |
| |
| Args: |
| parent: string, Required. The project and location from which the certificate should be listed, specified in the format `projects/*/locations/*`. (required) |
| filter: string, Filter expression to restrict the Certificates returned. |
| orderBy: string, A list of Certificate field names used to specify the order of the returned results. The default sorting order is ascending. To specify descending order for a field, add a suffix " desc". |
| pageSize: integer, Maximum number of certificates to return per call. |
| pageToken: string, The value returned by the last `ListCertificatesResponse`. Indicates that this is a continuation of a prior `ListCertificates` call, and that the system should return the next page of data. |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # Response for the `ListCertificates` method. |
| "certificates": [ # A list of certificates for the parent resource. |
| { # Defines TLS certificate. |
| "createTime": "A String", # Output only. The creation timestamp of a Certificate. |
| "description": "A String", # One or more paragraphs of text description of a certificate. |
| "expireTime": "A String", # Output only. The expiry timestamp of a Certificate. |
| "labels": { # Set of labels associated with a Certificate. |
| "a_key": "A String", |
| }, |
| "managed": { # Configuration and state of a Managed Certificate. Certificate Manager provisions and renews Managed Certificates automatically, for as long as it's authorized to do so. # If set, contains configuration and state of a managed certificate. |
| "authorizationAttemptInfo": [ # Output only. Detailed state of the latest authorization attempt for each domain specified for managed certificate resource. |
| { # State of the latest attempt to authorize a domain for certificate issuance. |
| "details": "A String", # Human readable explanation for reaching the state. Provided to help address the configuration issues. Not guaranteed to be stable. For programmatic access use Reason enum. |
| "domain": "A String", # Domain name of the authorization attempt. |
| "failureReason": "A String", # Output only. Reason for failure of the authorization attempt for the domain. |
| "state": "A String", # State of the domain for managed certificate issuance. |
| }, |
| ], |
| "dnsAuthorizations": [ # Immutable. Authorizations that will be used for performing domain authorization. |
| "A String", |
| ], |
| "domains": [ # Immutable. The domains for which a managed SSL certificate will be generated. Wildcard domains are only supported with DNS challenge resolution. |
| "A String", |
| ], |
| "provisioningIssue": { # Information about issues with provisioning a Managed Certificate. # Information about issues with provisioning a Managed Certificate. |
| "details": "A String", # Human readable explanation about the issue. Provided to help address the configuration issues. Not guaranteed to be stable. For programmatic access use Reason enum. |
| "reason": "A String", # Reason for provisioning failures. |
| }, |
| "state": "A String", # Output only. State of the managed certificate resource. |
| }, |
| "name": "A String", # A user-defined name of the certificate. Certificate names must be unique globally and match pattern `projects/*/locations/*/certificates/*`. |
| "pemCertificate": "A String", # Output only. The PEM-encoded certificate chain. |
| "sanDnsnames": [ # Output only. The list of Subject Alternative Names of dnsName type defined in the certificate (see RFC 5280 4.2.1.6) |
| "A String", |
| ], |
| "scope": "A String", # Immutable. The scope of the certificate. |
| "selfManaged": { # Certificate data for a SelfManaged Certificate. SelfManaged Certificates are uploaded by the user. Updating such certificates before they expire remains the user's responsibility. # If set, defines data of a self-managed certificate. |
| "pemCertificate": "A String", # Input only. The PEM-encoded certificate chain. Leaf certificate comes first, followed by intermediate ones if any. |
| "pemPrivateKey": "A String", # Input only. The PEM-encoded private key of the leaf certificate. |
| }, |
| "updateTime": "A String", # Output only. The last update timestamp of a Certificate. |
| }, |
| ], |
| "nextPageToken": "A String", # If there might be more results than those appearing in this response, then `next_page_token` is included. To get the next set of results, call this method again using the value of `next_page_token` as `page_token`. |
| "unreachable": [ # A list of locations 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, updateMask=None, x__xgafv=None)</code> |
| <pre>Updates a Certificate. |
| |
| Args: |
| name: string, A user-defined name of the certificate. Certificate names must be unique globally and match pattern `projects/*/locations/*/certificates/*`. (required) |
| body: object, The request body. |
| The object takes the form of: |
| |
| { # Defines TLS certificate. |
| "createTime": "A String", # Output only. The creation timestamp of a Certificate. |
| "description": "A String", # One or more paragraphs of text description of a certificate. |
| "expireTime": "A String", # Output only. The expiry timestamp of a Certificate. |
| "labels": { # Set of labels associated with a Certificate. |
| "a_key": "A String", |
| }, |
| "managed": { # Configuration and state of a Managed Certificate. Certificate Manager provisions and renews Managed Certificates automatically, for as long as it's authorized to do so. # If set, contains configuration and state of a managed certificate. |
| "authorizationAttemptInfo": [ # Output only. Detailed state of the latest authorization attempt for each domain specified for managed certificate resource. |
| { # State of the latest attempt to authorize a domain for certificate issuance. |
| "details": "A String", # Human readable explanation for reaching the state. Provided to help address the configuration issues. Not guaranteed to be stable. For programmatic access use Reason enum. |
| "domain": "A String", # Domain name of the authorization attempt. |
| "failureReason": "A String", # Output only. Reason for failure of the authorization attempt for the domain. |
| "state": "A String", # State of the domain for managed certificate issuance. |
| }, |
| ], |
| "dnsAuthorizations": [ # Immutable. Authorizations that will be used for performing domain authorization. |
| "A String", |
| ], |
| "domains": [ # Immutable. The domains for which a managed SSL certificate will be generated. Wildcard domains are only supported with DNS challenge resolution. |
| "A String", |
| ], |
| "provisioningIssue": { # Information about issues with provisioning a Managed Certificate. # Information about issues with provisioning a Managed Certificate. |
| "details": "A String", # Human readable explanation about the issue. Provided to help address the configuration issues. Not guaranteed to be stable. For programmatic access use Reason enum. |
| "reason": "A String", # Reason for provisioning failures. |
| }, |
| "state": "A String", # Output only. State of the managed certificate resource. |
| }, |
| "name": "A String", # A user-defined name of the certificate. Certificate names must be unique globally and match pattern `projects/*/locations/*/certificates/*`. |
| "pemCertificate": "A String", # Output only. The PEM-encoded certificate chain. |
| "sanDnsnames": [ # Output only. The list of Subject Alternative Names of dnsName type defined in the certificate (see RFC 5280 4.2.1.6) |
| "A String", |
| ], |
| "scope": "A String", # Immutable. The scope of the certificate. |
| "selfManaged": { # Certificate data for a SelfManaged Certificate. SelfManaged Certificates are uploaded by the user. Updating such certificates before they expire remains the user's responsibility. # If set, defines data of a self-managed certificate. |
| "pemCertificate": "A String", # Input only. The PEM-encoded certificate chain. Leaf certificate comes first, followed by intermediate ones if any. |
| "pemPrivateKey": "A String", # Input only. The PEM-encoded private key of the leaf certificate. |
| }, |
| "updateTime": "A String", # Output only. The last update timestamp of a Certificate. |
| } |
| |
| updateMask: string, Required. The update mask applies to the resource. For the `FieldMask` definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask. |
| 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> |
