{ "name": "certificatemanager", "resources": { "projects": { "resources": { "locations": { "methods": { "list": { "parameters": { "extraLocationTypes": { "type": "string", "description": "Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage.", "location": "query", "repeated": true }, "name": { "type": "string", "location": "path", "pattern": "^projects/[^/]+$", "description": "The resource that owns the locations collection, if applicable.", "required": true }, "pageToken": { "type": "string", "description": "A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page.", "location": "query" }, "pageSize": { "type": "integer", "description": "The maximum number of results to return. If not set, the service selects a default.", "location": "query", "format": "int32" }, "filter": { "type": "string", "description": "A filter to narrow down results to a preferred subset. The filtering language accepts strings like `\"displayName=tokyo\"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160).", "location": "query" } }, "description": "Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the [ListLocationsRequest.name] field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.", "id": "certificatemanager.projects.locations.list", "path": "v1/{+name}/locations", "httpMethod": "GET", "flatPath": "v1/projects/{projectsId}/locations", "parameterOrder": [ "name" ], "response": { "$ref": "ListLocationsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "get": { "parameterOrder": [ "name" ], "response": { "$ref": "Location" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "certificatemanager.projects.locations.get", "parameters": { "name": { "description": "Resource name for the location.", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+$", "type": "string", "location": "path" } }, "description": "Gets information about a location.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}", "path": "v1/{+name}", "httpMethod": "GET" } }, "resources": { "trustConfigs": { "methods": { "create": { "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/trustConfigs", "path": "v1/{+parent}/trustConfigs", "httpMethod": "POST", "id": "certificatemanager.projects.locations.trustConfigs.create", "parameters": { "parent": { "type": "string", "location": "path", "description": "Required. The parent resource of the TrustConfig. Must be in the format `projects/*/locations/*`.", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+$" }, "trustConfigId": { "description": "Required. A user-provided name of the TrustConfig. Must match the regexp `[a-z0-9-]{1,63}`.", "location": "query", "type": "string" } }, "description": "Creates a new TrustConfig in a given project and location.", "parameterOrder": [ "parent" ], "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "request": { "$ref": "TrustConfig" } }, "patch": { "request": { "$ref": "TrustConfig" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ], "response": { "$ref": "Operation" }, "description": "Updates a TrustConfig.", "parameters": { "name": { "location": "path", "type": "string", "description": "Identifier. A user-defined name of the trust config. TrustConfig names must be unique globally and match pattern `projects/*/locations/*/trustConfigs/*`.", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/trustConfigs/[^/]+$" }, "updateMask": { "description": "Required. The update mask applies to the resource. For the `FieldMask` definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask.", "location": "query", "format": "google-fieldmask", "type": "string" } }, "id": "certificatemanager.projects.locations.trustConfigs.patch", "path": "v1/{+name}", "httpMethod": "PATCH", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/trustConfigs/{trustConfigsId}" }, "delete": { "path": "v1/{+name}", "httpMethod": "DELETE", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/trustConfigs/{trustConfigsId}", "description": "Deletes a single TrustConfig.", "parameters": { "name": { "description": "Required. A name of the TrustConfig to delete. Must be in the format `projects/*/locations/*/trustConfigs/*`.", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/trustConfigs/[^/]+$", "type": "string", "location": "path" }, "etag": { "description": "Optional. The current etag of the TrustConfig. If an etag is provided and does not match the current etag of the resource, deletion will be blocked and an ABORTED error will be returned.", "location": "query", "type": "string" } }, "id": "certificatemanager.projects.locations.trustConfigs.delete", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ], "response": { "$ref": "Operation" } }, "get": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ], "response": { "$ref": "TrustConfig" }, "description": "Gets details of a single TrustConfig.", "parameters": { "name": { "description": "Required. A name of the TrustConfig to describe. Must be in the format `projects/*/locations/*/trustConfigs/*`.", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/trustConfigs/[^/]+$", "type": "string", "location": "path" } }, "id": "certificatemanager.projects.locations.trustConfigs.get", "path": "v1/{+name}", "httpMethod": "GET", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/trustConfigs/{trustConfigsId}" }, "list": { "path": "v1/{+parent}/trustConfigs", "httpMethod": "GET", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/trustConfigs", "parameters": { "filter": { "description": "Optional. Filter expression to restrict the TrustConfigs returned.", "location": "query", "type": "string" }, "parent": { "location": "path", "type": "string", "description": "Required. The project and location from which the TrustConfigs should be listed, specified in the format `projects/*/locations/*`.", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+$" }, "pageSize": { "description": "Optional. Maximum number of TrustConfigs to return per call.", "location": "query", "format": "int32", "type": "integer" }, "pageToken": { "description": "Optional. The value returned by the last `ListTrustConfigsResponse`. Indicates that this is a continuation of a prior `ListTrustConfigs` call, and that the system should return the next page of data.", "location": "query", "type": "string" }, "orderBy": { "type": "string", "description": "Optional. A list of TrustConfig 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\"`.", "location": "query" } }, "description": "Lists TrustConfigs in a given project and location.", "id": "certificatemanager.projects.locations.trustConfigs.list", "parameterOrder": [ "parent" ], "response": { "$ref": "ListTrustConfigsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] } } }, "operations": { "methods": { "list": { "path": "v1/{+name}/operations", "httpMethod": "GET", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/operations", "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", "parameters": { "pageSize": { "description": "The standard list page size.", "location": "query", "format": "int32", "type": "integer" }, "filter": { "type": "string", "description": "The standard list filter.", "location": "query" }, "returnPartialSuccess": { "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", "location": "query", "type": "boolean" }, "name": { "pattern": "^projects/[^/]+/locations/[^/]+$", "description": "The name of the operation's parent resource.", "required": true, "type": "string", "location": "path" }, "pageToken": { "type": "string", "description": "The standard list page token.", "location": "query" } }, "id": "certificatemanager.projects.locations.operations.list", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ], "response": { "$ref": "ListOperationsResponse" } }, "delete": { "id": "certificatemanager.projects.locations.operations.delete", "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", "parameters": { "name": { "type": "string", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$", "description": "The name of the operation resource to be deleted.", "required": true } }, "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}", "path": "v1/{+name}", "httpMethod": "DELETE", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ], "response": { "$ref": "Empty" } }, "get": { "id": "certificatemanager.projects.locations.operations.get", "parameters": { "name": { "description": "The name of the operation resource.", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$", "location": "path", "type": "string" } }, "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}", "path": "v1/{+name}", "httpMethod": "GET", "parameterOrder": [ "name" ], "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "cancel": { "path": "v1/{+name}:cancel", "httpMethod": "POST", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel", "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", "parameters": { "name": { "description": "The name of the operation resource to be cancelled.", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$", "location": "path", "type": "string" } }, "id": "certificatemanager.projects.locations.operations.cancel", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ], "response": { "$ref": "Empty" }, "request": { "$ref": "CancelOperationRequest" } } } }, "certificates": { "methods": { "patch": { "request": { "$ref": "Certificate" }, "parameterOrder": [ "name" ], "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "name": { "location": "path", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/certificates/[^/]+$", "description": "Identifier. A user-defined name of the certificate. Certificate names must be unique globally and match pattern `projects/*/locations/*/certificates/*`.", "required": true }, "updateMask": { "description": "Required. The update mask applies to the resource. For the `FieldMask` definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask.", "location": "query", "format": "google-fieldmask", "type": "string" } }, "description": "Updates a Certificate.", "id": "certificatemanager.projects.locations.certificates.patch", "path": "v1/{+name}", "httpMethod": "PATCH", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/certificates/{certificatesId}" }, "delete": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ], "response": { "$ref": "Operation" }, "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/certificates/{certificatesId}", "path": "v1/{+name}", "httpMethod": "DELETE", "id": "certificatemanager.projects.locations.certificates.delete", "description": "Deletes a single Certificate.", "parameters": { "name": { "type": "string", "location": "path", "description": "Required. A name of the certificate to delete. Must be in the format `projects/*/locations/*/certificates/*`.", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/certificates/[^/]+$" } } }, "get": { "parameterOrder": [ "name" ], "response": { "$ref": "Certificate" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "name": { "location": "path", "type": "string", "description": "Required. A name of the certificate to describe. Must be in the format `projects/*/locations/*/certificates/*`.", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/certificates/[^/]+$" } }, "description": "Gets details of a single Certificate.", "id": "certificatemanager.projects.locations.certificates.get", "path": "v1/{+name}", "httpMethod": "GET", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/certificates/{certificatesId}" }, "list": { "id": "certificatemanager.projects.locations.certificates.list", "parameters": { "pageToken": { "description": "Optional. 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.", "location": "query", "type": "string" }, "orderBy": { "type": "string", "description": "Optional. 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\"`.", "location": "query" }, "filter": { "description": "Optional. Filter expression to restrict the Certificates returned.", "location": "query", "type": "string" }, "parent": { "pattern": "^projects/[^/]+/locations/[^/]+$", "description": "Required. The project and location from which the certificate should be listed, specified in the format `projects/*/locations/*`.", "required": true, "type": "string", "location": "path" }, "pageSize": { "type": "integer", "description": "Optional. Maximum number of certificates to return per call.", "location": "query", "format": "int32" } }, "description": "Lists Certificates in a given project and location.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/certificates", "path": "v1/{+parent}/certificates", "httpMethod": "GET", "parameterOrder": [ "parent" ], "response": { "$ref": "ListCertificatesResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "create": { "id": "certificatemanager.projects.locations.certificates.create", "description": "Creates a new Certificate in a given project and location.", "parameters": { "parent": { "location": "path", "type": "string", "description": "Required. The parent resource of the certificate. Must be in the format `projects/*/locations/*`.", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+$" }, "certificateId": { "type": "string", "description": "Required. A user-provided name of the certificate.", "location": "query" } }, "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/certificates", "path": "v1/{+parent}/certificates", "httpMethod": "POST", "request": { "$ref": "Certificate" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "parent" ], "response": { "$ref": "Operation" } } } }, "dnsAuthorizations": { "methods": { "patch": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ], "response": { "$ref": "Operation" }, "request": { "$ref": "DnsAuthorization" }, "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dnsAuthorizations/{dnsAuthorizationsId}", "path": "v1/{+name}", "httpMethod": "PATCH", "id": "certificatemanager.projects.locations.dnsAuthorizations.patch", "description": "Updates a DnsAuthorization.", "parameters": { "name": { "type": "string", "location": "path", "description": "Identifier. A user-defined name of the dns authorization. DnsAuthorization names must be unique globally and match pattern `projects/*/locations/*/dnsAuthorizations/*`.", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/dnsAuthorizations/[^/]+$" }, "updateMask": { "type": "string", "description": "Required. The update mask applies to the resource. For the `FieldMask` definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask.", "location": "query", "format": "google-fieldmask" } } }, "delete": { "parameterOrder": [ "name" ], "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "name": { "description": "Required. A name of the dns authorization to delete. Must be in the format `projects/*/locations/*/dnsAuthorizations/*`.", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/dnsAuthorizations/[^/]+$", "location": "path", "type": "string" } }, "description": "Deletes a single DnsAuthorization.", "id": "certificatemanager.projects.locations.dnsAuthorizations.delete", "path": "v1/{+name}", "httpMethod": "DELETE", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dnsAuthorizations/{dnsAuthorizationsId}" }, "get": { "parameterOrder": [ "name" ], "response": { "$ref": "DnsAuthorization" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "certificatemanager.projects.locations.dnsAuthorizations.get", "parameters": { "name": { "type": "string", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/dnsAuthorizations/[^/]+$", "description": "Required. A name of the dns authorization to describe. Must be in the format `projects/*/locations/*/dnsAuthorizations/*`.", "required": true } }, "description": "Gets details of a single DnsAuthorization.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dnsAuthorizations/{dnsAuthorizationsId}", "path": "v1/{+name}", "httpMethod": "GET" }, "list": { "description": "Lists DnsAuthorizations in a given project and location.", "parameters": { "pageToken": { "description": "Optional. The value returned by the last `ListDnsAuthorizationsResponse`. Indicates that this is a continuation of a prior `ListDnsAuthorizations` call, and that the system should return the next page of data.", "location": "query", "type": "string" }, "orderBy": { "description": "Optional. A list of Dns Authorization 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\"`.", "location": "query", "type": "string" }, "parent": { "type": "string", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "description": "Required. The project and location from which the dns authorizations should be listed, specified in the format `projects/*/locations/*`.", "required": true }, "pageSize": { "type": "integer", "description": "Optional. Maximum number of dns authorizations to return per call.", "location": "query", "format": "int32" }, "filter": { "type": "string", "description": "Optional. Filter expression to restrict the Dns Authorizations returned.", "location": "query" } }, "id": "certificatemanager.projects.locations.dnsAuthorizations.list", "path": "v1/{+parent}/dnsAuthorizations", "httpMethod": "GET", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dnsAuthorizations", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "parent" ], "response": { "$ref": "ListDnsAuthorizationsResponse" } }, "create": { "request": { "$ref": "DnsAuthorization" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "parent" ], "response": { "$ref": "Operation" }, "description": "Creates a new DnsAuthorization in a given project and location.", "parameters": { "parent": { "description": "Required. The parent resource of the dns authorization. Must be in the format `projects/*/locations/*`.", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+$", "location": "path", "type": "string" }, "dnsAuthorizationId": { "description": "Required. A user-provided name of the dns authorization.", "location": "query", "type": "string" } }, "id": "certificatemanager.projects.locations.dnsAuthorizations.create", "path": "v1/{+parent}/dnsAuthorizations", "httpMethod": "POST", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dnsAuthorizations" } } }, "certificateMaps": { "methods": { "create": { "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/certificateMaps", "path": "v1/{+parent}/certificateMaps", "httpMethod": "POST", "id": "certificatemanager.projects.locations.certificateMaps.create", "parameters": { "certificateMapId": { "description": "Required. A user-provided name of the certificate map.", "location": "query", "type": "string" }, "parent": { "location": "path", "type": "string", "description": "Required. The parent resource of the certificate map. Must be in the format `projects/*/locations/*`.", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+$" } }, "description": "Creates a new CertificateMap in a given project and location.", "parameterOrder": [ "parent" ], "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "request": { "$ref": "CertificateMap" } }, "list": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "parent" ], "response": { "$ref": "ListCertificateMapsResponse" }, "path": "v1/{+parent}/certificateMaps", "httpMethod": "GET", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/certificateMaps", "description": "Lists CertificateMaps in a given project and location.", "parameters": { "parent": { "location": "path", "type": "string", "description": "Required. The project and location from which the certificate maps should be listed, specified in the format `projects/*/locations/*`.", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+$" }, "pageSize": { "type": "integer", "description": "Optional. Maximum number of certificate maps to return per call.", "location": "query", "format": "int32" }, "filter": { "description": "Optional. Filter expression to restrict the Certificates Maps returned.", "location": "query", "type": "string" }, "pageToken": { "type": "string", "description": "Optional. The value returned by the last `ListCertificateMapsResponse`. Indicates that this is a continuation of a prior `ListCertificateMaps` call, and that the system should return the next page of data.", "location": "query" }, "orderBy": { "type": "string", "description": "Optional. A list of Certificate Map 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\"`.", "location": "query" } }, "id": "certificatemanager.projects.locations.certificateMaps.list" }, "get": { "parameterOrder": [ "name" ], "response": { "$ref": "CertificateMap" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1/{+name}", "httpMethod": "GET", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/certificateMaps/{certificateMapsId}", "parameters": { "name": { "type": "string", "location": "path", "description": "Required. A name of the certificate map to describe. Must be in the format `projects/*/locations/*/certificateMaps/*`.", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/certificateMaps/[^/]+$" } }, "description": "Gets details of a single CertificateMap.", "id": "certificatemanager.projects.locations.certificateMaps.get" }, "patch": { "id": "certificatemanager.projects.locations.certificateMaps.patch", "description": "Updates a CertificateMap.", "parameters": { "name": { "type": "string", "location": "path", "description": "Identifier. A user-defined name of the Certificate Map. Certificate Map names must be unique globally and match pattern `projects/*/locations/*/certificateMaps/*`.", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/certificateMaps/[^/]+$" }, "updateMask": { "description": "Required. The update mask applies to the resource. For the `FieldMask` definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask.", "location": "query", "format": "google-fieldmask", "type": "string" } }, "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/certificateMaps/{certificateMapsId}", "path": "v1/{+name}", "httpMethod": "PATCH", "request": { "$ref": "CertificateMap" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ], "response": { "$ref": "Operation" } }, "delete": { "parameters": { "name": { "type": "string", "location": "path", "description": "Required. A name of the certificate map to delete. Must be in the format `projects/*/locations/*/certificateMaps/*`.", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/certificateMaps/[^/]+$" } }, "description": "Deletes a single CertificateMap. A Certificate Map can't be deleted if it contains Certificate Map Entries. Remove all the entries from the map before calling this method.", "id": "certificatemanager.projects.locations.certificateMaps.delete", "path": "v1/{+name}", "httpMethod": "DELETE", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/certificateMaps/{certificateMapsId}", "parameterOrder": [ "name" ], "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] } }, "resources": { "certificateMapEntries": { "methods": { "patch": { "path": "v1/{+name}", "httpMethod": "PATCH", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/certificateMaps/{certificateMapsId}/certificateMapEntries/{certificateMapEntriesId}", "parameters": { "name": { "description": "Identifier. A user-defined name of the Certificate Map Entry. Certificate Map Entry names must be unique globally and match pattern `projects/*/locations/*/certificateMaps/*/certificateMapEntries/*`.", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/certificateMaps/[^/]+/certificateMapEntries/[^/]+$", "type": "string", "location": "path" }, "updateMask": { "type": "string", "description": "Required. The update mask applies to the resource. For the `FieldMask` definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask.", "location": "query", "format": "google-fieldmask" } }, "description": "Updates a CertificateMapEntry.", "id": "certificatemanager.projects.locations.certificateMaps.certificateMapEntries.patch", "parameterOrder": [ "name" ], "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "request": { "$ref": "CertificateMapEntry" } }, "delete": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ], "response": { "$ref": "Operation" }, "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/certificateMaps/{certificateMapsId}/certificateMapEntries/{certificateMapEntriesId}", "path": "v1/{+name}", "httpMethod": "DELETE", "id": "certificatemanager.projects.locations.certificateMaps.certificateMapEntries.delete", "description": "Deletes a single CertificateMapEntry.", "parameters": { "name": { "location": "path", "type": "string", "description": "Required. A name of the certificate map entry to delete. Must be in the format `projects/*/locations/*/certificateMaps/*/certificateMapEntries/*`.", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/certificateMaps/[^/]+/certificateMapEntries/[^/]+$" } } }, "get": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ], "response": { "$ref": "CertificateMapEntry" }, "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/certificateMaps/{certificateMapsId}/certificateMapEntries/{certificateMapEntriesId}", "path": "v1/{+name}", "httpMethod": "GET", "id": "certificatemanager.projects.locations.certificateMaps.certificateMapEntries.get", "description": "Gets details of a single CertificateMapEntry.", "parameters": { "name": { "description": "Required. A name of the certificate map entry to describe. Must be in the format `projects/*/locations/*/certificateMaps/*/certificateMapEntries/*`.", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/certificateMaps/[^/]+/certificateMapEntries/[^/]+$", "type": "string", "location": "path" } } }, "list": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "parent" ], "response": { "$ref": "ListCertificateMapEntriesResponse" }, "description": "Lists CertificateMapEntries in a given project and location.", "parameters": { "pageToken": { "description": "Optional. The value returned by the last `ListCertificateMapEntriesResponse`. Indicates that this is a continuation of a prior `ListCertificateMapEntries` call, and that the system should return the next page of data.", "location": "query", "type": "string" }, "orderBy": { "description": "Optional. A list of Certificate Map Entry 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\"`.", "location": "query", "type": "string" }, "filter": { "description": "Optional. Filter expression to restrict the returned Certificate Map Entries.", "location": "query", "type": "string" }, "pageSize": { "description": "Optional. Maximum number of certificate map entries to return. The service may return fewer than this value. If unspecified, at most 50 certificate map entries will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.", "location": "query", "format": "int32", "type": "integer" }, "parent": { "pattern": "^projects/[^/]+/locations/[^/]+/certificateMaps/[^/]+$", "description": "Required. The project, location and certificate map from which the certificate map entries should be listed, specified in the format `projects/*/locations/*/certificateMaps/*`.", "required": true, "location": "path", "type": "string" } }, "id": "certificatemanager.projects.locations.certificateMaps.certificateMapEntries.list", "path": "v1/{+parent}/certificateMapEntries", "httpMethod": "GET", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/certificateMaps/{certificateMapsId}/certificateMapEntries" }, "create": { "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/certificateMaps/{certificateMapsId}/certificateMapEntries", "path": "v1/{+parent}/certificateMapEntries", "httpMethod": "POST", "id": "certificatemanager.projects.locations.certificateMaps.certificateMapEntries.create", "parameters": { "parent": { "description": "Required. The parent resource of the certificate map entry. Must be in the format `projects/*/locations/*/certificateMaps/*`.", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/certificateMaps/[^/]+$", "type": "string", "location": "path" }, "certificateMapEntryId": { "type": "string", "description": "Required. A user-provided name of the certificate map entry.", "location": "query" } }, "description": "Creates a new CertificateMapEntry in a given project and location.", "parameterOrder": [ "parent" ], "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "request": { "$ref": "CertificateMapEntry" } } } } } }, "certificateIssuanceConfigs": { "methods": { "create": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "parent" ], "response": { "$ref": "Operation" }, "request": { "$ref": "CertificateIssuanceConfig" }, "path": "v1/{+parent}/certificateIssuanceConfigs", "httpMethod": "POST", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/certificateIssuanceConfigs", "description": "Creates a new CertificateIssuanceConfig in a given project and location.", "parameters": { "parent": { "pattern": "^projects/[^/]+/locations/[^/]+$", "description": "Required. The parent resource of the certificate issuance config. Must be in the format `projects/*/locations/*`.", "required": true, "location": "path", "type": "string" }, "certificateIssuanceConfigId": { "type": "string", "description": "Required. A user-provided name of the certificate config.", "location": "query" } }, "id": "certificatemanager.projects.locations.certificateIssuanceConfigs.create" }, "list": { "description": "Lists CertificateIssuanceConfigs in a given project and location.", "parameters": { "pageToken": { "type": "string", "description": "Optional. The value returned by the last `ListCertificateIssuanceConfigsResponse`. Indicates that this is a continuation of a prior `ListCertificateIssuanceConfigs` call, and that the system should return the next page of data.", "location": "query" }, "orderBy": { "description": "Optional. A list of Certificate Config 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\"`.", "location": "query", "type": "string" }, "filter": { "type": "string", "description": "Optional. Filter expression to restrict the Certificates Configs returned.", "location": "query" }, "pageSize": { "type": "integer", "description": "Optional. Maximum number of certificate configs to return per call.", "location": "query", "format": "int32" }, "parent": { "pattern": "^projects/[^/]+/locations/[^/]+$", "description": "Required. The project and location from which the certificate should be listed, specified in the format `projects/*/locations/*`.", "required": true, "type": "string", "location": "path" } }, "id": "certificatemanager.projects.locations.certificateIssuanceConfigs.list", "path": "v1/{+parent}/certificateIssuanceConfigs", "httpMethod": "GET", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/certificateIssuanceConfigs", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "parent" ], "response": { "$ref": "ListCertificateIssuanceConfigsResponse" } }, "get": { "parameters": { "name": { "location": "path", "type": "string", "description": "Required. A name of the certificate issuance config to describe. Must be in the format `projects/*/locations/*/certificateIssuanceConfigs/*`.", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/certificateIssuanceConfigs/[^/]+$" } }, "description": "Gets details of a single CertificateIssuanceConfig.", "id": "certificatemanager.projects.locations.certificateIssuanceConfigs.get", "path": "v1/{+name}", "httpMethod": "GET", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/certificateIssuanceConfigs/{certificateIssuanceConfigsId}", "parameterOrder": [ "name" ], "response": { "$ref": "CertificateIssuanceConfig" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "patch": { "path": "v1/{+name}", "httpMethod": "PATCH", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/certificateIssuanceConfigs/{certificateIssuanceConfigsId}", "parameters": { "name": { "type": "string", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/certificateIssuanceConfigs/[^/]+$", "description": "Identifier. A user-defined name of the certificate issuance config. CertificateIssuanceConfig names must be unique globally and match pattern `projects/*/locations/*/certificateIssuanceConfigs/*`.", "required": true }, "updateMask": { "description": "Required. The update mask applies to the resource. For the `FieldMask` definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask.", "location": "query", "format": "google-fieldmask", "type": "string" } }, "description": "Updates a CertificateIssuanceConfig.", "id": "certificatemanager.projects.locations.certificateIssuanceConfigs.patch", "parameterOrder": [ "name" ], "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "request": { "$ref": "CertificateIssuanceConfig" } }, "delete": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ], "response": { "$ref": "Operation" }, "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/certificateIssuanceConfigs/{certificateIssuanceConfigsId}", "path": "v1/{+name}", "httpMethod": "DELETE", "id": "certificatemanager.projects.locations.certificateIssuanceConfigs.delete", "description": "Deletes a single CertificateIssuanceConfig.", "parameters": { "name": { "location": "path", "type": "string", "description": "Required. A name of the certificate issuance config to delete. Must be in the format `projects/*/locations/*/certificateIssuanceConfigs/*`.", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/certificateIssuanceConfigs/[^/]+$" } } } } } } } } } }, "description": "", "fullyEncodeReservedExpansion": true, "baseUrl": "https://certificatemanager.googleapis.com/", "auth": { "oauth2": { "scopes": { "https://www.googleapis.com/auth/cloud-platform": { "description": "See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account." } } } }, "discoveryVersion": "v1", "rootUrl": "https://certificatemanager.googleapis.com/", "batchPath": "batch", "basePath": "", "mtlsRootUrl": "https://certificatemanager.mtls.googleapis.com/", "title": "Certificate Manager API", "version": "v1", "canonicalName": "Certificate Manager", "icons": { "x32": "http://www.google.com/images/icons/product/search-32.gif", "x16": "http://www.google.com/images/icons/product/search-16.gif" }, "parameters": { "quotaUser": { "type": "string", "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.", "location": "query" }, "key": { "type": "string", "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.", "location": "query" }, "prettyPrint": { "description": "Returns response with indentations and line breaks.", "default": "true", "location": "query", "type": "boolean" }, "$.xgafv": { "enumDescriptions": [ "v1 error format", "v2 error format" ], "location": "query", "type": "string", "description": "V1 error format.", "enum": [ "1", "2" ] }, "alt": { "type": "string", "default": "json", "enumDescriptions": [ "Responses with Content-Type of application/json", "Media download with context-dependent Content-Type", "Responses with Content-Type of application/x-protobuf" ], "location": "query", "enum": [ "json", "media", "proto" ], "description": "Data format for response." }, "fields": { "description": "Selector specifying which fields to include in a partial response.", "location": "query", "type": "string" }, "access_token": { "type": "string", "description": "OAuth access token.", "location": "query" }, "uploadType": { "type": "string", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", "location": "query" }, "callback": { "type": "string", "description": "JSONP", "location": "query" }, "oauth_token": { "description": "OAuth 2.0 token for the current user.", "location": "query", "type": "string" }, "upload_protocol": { "type": "string", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", "location": "query" } }, "version_module": true, "revision": "20260405", "id": "certificatemanager:v1", "ownerName": "Google", "servicePath": "", "ownerDomain": "google.com", "kind": "discovery#restDescription", "protocol": "rest", "documentationLink": "https://docs.cloud.google.com/certificate-manager/docs/overview", "schemas": { "IpConfig": { "id": "IpConfig", "properties": { "ipAddress": { "description": "Output only. An external IP address.", "type": "string", "readOnly": true }, "ports": { "readOnly": true, "items": { "format": "uint32", "type": "integer" }, "description": "Output only. Ports.", "type": "array" } }, "description": "Defines IP configuration where this Certificate Map is serving.", "type": "object" }, "ProvisioningIssue": { "id": "ProvisioningIssue", "properties": { "reason": { "description": "Output only. Reason for provisioning failures.", "enum": [ "REASON_UNSPECIFIED", "AUTHORIZATION_ISSUE", "RATE_LIMITED" ], "readOnly": true, "enumDescriptions": [ "Reason is unspecified.", "Certificate provisioning failed due to an issue with one or more of the domains on the certificate. For details of which domains failed, consult the `authorization_attempt_info` field.", "Exceeded Certificate Authority quotas or internal rate limits of the system. Provisioning may take longer to complete." ], "type": "string" }, "details": { "readOnly": true, "description": "Output only. Human readable explanation about the issue. Provided to help address the configuration issues. Not guaranteed to be stable. For programmatic access use Reason enum.", "type": "string" } }, "type": "object", "description": "Information about issues with provisioning a Managed Certificate." }, "Operation": { "id": "Operation", "properties": { "metadata": { "description": "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.", "additionalProperties": { "description": "Properties of the object. Contains field @type with type URL.", "type": "any" }, "type": "object" }, "done": { "type": "boolean", "description": "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": { "$ref": "Status", "description": "The error result of the operation in case of failure or cancellation." }, "name": { "description": "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}`.", "type": "string" }, "response": { "description": "The normal, successful response of the operation. 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`.", "additionalProperties": { "type": "any", "description": "Properties of the object. Contains field @type with type URL." }, "type": "object" } }, "type": "object", "description": "This resource represents a long-running operation that is the result of a network API call." }, "TrustAnchor": { "type": "object", "description": "Defines a trust anchor.", "id": "TrustAnchor", "properties": { "pemCertificate": { "type": "string", "description": "PEM root certificate of the PKI used for validation. Each certificate provided in PEM format may occupy up to 5kB." } } }, "Troubleshooting": { "id": "Troubleshooting", "properties": { "issues": { "readOnly": true, "items": { "enumDescriptions": [ "Issue is unspecified.", "The resolved CNAME value doesn't match the expected CNAME.", "Domain has A/AAAA records that point to IPs, where the certificate is not attached.", "Domain has A/AAAA records that point to IPs, where the certificate is attached, but port 443 is not open.", "Domain doesn't have any A/AAAA records.", "Certificate is not configured to be served from any IPs (e.g. Certificate is not attached to any load balancer)." ], "type": "string", "enum": [ "ISSUE_UNSPECIFIED", "CNAME_MISMATCH", "RESOLVED_TO_NOT_SERVING", "RESOLVED_TO_SERVING_ON_ALT_PORTS", "NO_RESOLVED_IPS", "CERTIFICATE_NOT_ATTACHED" ] }, "description": "Output only. The list of issues discovered during the authorization attempt.", "type": "array" }, "ips": { "description": "Output only. IPs troubleshooting information.", "readOnly": true, "$ref": "IPs" }, "cname": { "description": "Output only. CNAME troubleshooting information.", "readOnly": true, "$ref": "CNAME" } }, "description": "Troubleshooting information for the authorization attempt.", "type": "object" }, "ListCertificateMapEntriesResponse": { "id": "ListCertificateMapEntriesResponse", "properties": { "certificateMapEntries": { "items": { "$ref": "CertificateMapEntry" }, "type": "array", "description": "A list of certificate map entries for the parent resource." }, "unreachable": { "type": "array", "description": "Locations that could not be reached.", "items": { "type": "string" } }, "nextPageToken": { "type": "string", "description": "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`." } }, "type": "object", "description": "Response for the `ListCertificateMapEntries` method." }, "CancelOperationRequest": { "id": "CancelOperationRequest", "properties": {}, "type": "object", "description": "The request message for Operations.CancelOperation." }, "Status": { "id": "Status", "properties": { "message": { "type": "string", "description": "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." }, "details": { "type": "array", "description": "A list of messages that carry the error details. There is a common set of message types for APIs to use.", "items": { "type": "object", "additionalProperties": { "description": "Properties of the object. Contains field @type with type URL.", "type": "any" } } }, "code": { "description": "The status code, which should be an enum value of google.rpc.Code.", "format": "int32", "type": "integer" } }, "description": "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).", "type": "object" }, "ManagedIdentityCertificate": { "id": "ManagedIdentityCertificate", "properties": { "identity": { "description": "Required. Immutable. SPIFFE ID of the Managed Identity used for this certificate.", "type": "string" }, "state": { "type": "string", "enumDescriptions": [ "State is unspecified.", "Certificate Manager attempts to provision or renew the certificate. If the process takes longer than expected, consult the `provisioning_issue` field.", "Multiple certificate provisioning attempts failed and Certificate Manager gave up. To try again, delete and create a new managed Certificate resource. For details see the `provisioning_issue` field.", "The certificate management is working, and a certificate has been provisioned." ], "enum": [ "STATE_UNSPECIFIED", "PROVISIONING", "FAILED", "ACTIVE" ], "description": "Output only. State of the managed certificate resource.", "readOnly": true }, "provisioningIssue": { "readOnly": true, "$ref": "ProvisioningIssue", "description": "Output only. Information about issues with provisioning a managed certificate." } }, "type": "object", "description": "Configuration and state of a Managed Identity Certificate. Certificate Manager provisions and renews Managed Identity Certificates automatically, for as long as it's authorized to do so." }, "DnsAuthorization": { "type": "object", "description": "A DnsAuthorization resource describes a way to perform domain authorization for certificate issuance.", "id": "DnsAuthorization", "properties": { "createTime": { "type": "string", "description": "Output only. The creation timestamp of a DnsAuthorization.", "format": "google-datetime", "readOnly": true }, "description": { "type": "string", "description": "Optional. One or more paragraphs of text description of a DnsAuthorization." }, "domain": { "description": "Required. Immutable. A domain that is being authorized. A DnsAuthorization resource covers a single domain and its wildcard, e.g. authorization for `example.com` can be used to issue certificates for `example.com` and `*.example.com`.", "type": "string" }, "dnsResourceRecord": { "description": "Output only. DNS Resource Record that needs to be added to DNS configuration.", "readOnly": true, "$ref": "DnsResourceRecord" }, "name": { "description": "Identifier. A user-defined name of the dns authorization. DnsAuthorization names must be unique globally and match pattern `projects/*/locations/*/dnsAuthorizations/*`.", "type": "string" }, "type": { "type": "string", "enum": [ "TYPE_UNSPECIFIED", "FIXED_RECORD", "PER_PROJECT_RECORD" ], "description": "Optional. Immutable. Type of DnsAuthorization. If unset during resource creation the following default will be used: - in location `global`: FIXED_RECORD, - in other locations: PER_PROJECT_RECORD.", "enumDescriptions": [ "Type is unspecified.", "FIXED_RECORD DNS authorization uses DNS-01 validation method.", "PER_PROJECT_RECORD DNS authorization allows for independent management of Google-managed certificates with DNS authorization across multiple projects." ] }, "updateTime": { "readOnly": true, "type": "string", "description": "Output only. The last update timestamp of a DnsAuthorization.", "format": "google-datetime" }, "labels": { "type": "object", "description": "Optional. Set of labels associated with a DnsAuthorization.", "additionalProperties": { "type": "string" } } } }, "OperationMetadata": { "id": "OperationMetadata", "properties": { "createTime": { "description": "The time the operation was created.", "format": "google-datetime", "type": "string" }, "endTime": { "type": "string", "description": "The time the operation finished running.", "format": "google-datetime" }, "target": { "description": "Server-defined resource path for the target of the operation.", "type": "string" }, "apiVersion": { "type": "string", "description": "API version used to start the operation." }, "statusMessage": { "type": "string", "description": "Human-readable status of the operation, if any." }, "verb": { "description": "Name of the verb executed by the operation.", "type": "string" }, "requestedCancellation": { "type": "boolean", "description": "Identifies whether the user has requested cancellation of the operation. Operations that have successfully been cancelled have google.longrunning.Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`." } }, "description": "Represents the metadata of the long-running operation. Output only.", "type": "object" }, "Certificate": { "id": "Certificate", "properties": { "pemCertificate": { "readOnly": true, "type": "string", "description": "Output only. The PEM-encoded certificate chain." }, "name": { "description": "Identifier. A user-defined name of the certificate. Certificate names must be unique globally and match pattern `projects/*/locations/*/certificates/*`.", "type": "string" }, "description": { "type": "string", "description": "Optional. One or more paragraphs of text description of a certificate." }, "selfManaged": { "$ref": "SelfManagedCertificate", "description": "If set, defines data of a self-managed certificate." }, "expireTime": { "type": "string", "description": "Output only. The expiry timestamp of a Certificate.", "format": "google-datetime", "readOnly": true }, "updateTime": { "description": "Output only. The last update timestamp of a Certificate.", "format": "google-datetime", "type": "string", "readOnly": true }, "managedIdentity": { "$ref": "ManagedIdentityCertificate", "description": "If set, contains configuration and state of a managed identity certificate." }, "createTime": { "type": "string", "description": "Output only. The creation timestamp of a Certificate.", "format": "google-datetime", "readOnly": true }, "managed": { "$ref": "ManagedCertificate", "description": "If set, contains configuration and state of a managed certificate." }, "labels": { "description": "Optional. Set of labels associated with a Certificate.", "additionalProperties": { "type": "string" }, "type": "object" }, "usedBy": { "readOnly": true, "items": { "$ref": "UsedBy" }, "type": "array", "description": "Output only. The list of resources that use this Certificate." }, "scope": { "description": "Optional. Immutable. The scope of the certificate.", "enumDescriptions": [ "Use the DEFAULT scope if you plan to use the certificate with global external Application Load Balancer, global external proxy Network Load Balancer, or any of the regional Google Cloud services.", "Use the EDGE_CACHE scope if you plan to use the certificate with Media CDN. The certificates are served from Edge Points of Presence. See https://cloud.google.com/vpc/docs/edge-locations.", "Use the ALL_REGIONS scope if you plan to use the certificate with cross-region internal Application Load Balancer. The certificates are served from all Google Cloud regions. See https://cloud.google.com/compute/docs/regions-zones.", "Associated with certificates used as client certificates in Backend mTLS." ], "type": "string", "enum": [ "DEFAULT", "EDGE_CACHE", "ALL_REGIONS", "CLIENT_AUTH" ] }, "sanDnsnames": { "readOnly": true, "items": { "type": "string" }, "type": "array", "description": "Output only. The list of Subject Alternative Names of dnsName type defined in the certificate (see RFC 5280 4.2.1.6). Managed certificates that haven't been provisioned yet have this field populated with a value of the managed.domains field." } }, "description": "Defines TLS certificate.", "type": "object" }, "ListCertificateIssuanceConfigsResponse": { "description": "Response for the `ListCertificateIssuanceConfigs` method.", "type": "object", "id": "ListCertificateIssuanceConfigsResponse", "properties": { "nextPageToken": { "type": "string", "description": "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`." }, "certificateIssuanceConfigs": { "items": { "$ref": "CertificateIssuanceConfig" }, "description": "A list of certificate configs for the parent resource.", "type": "array" }, "unreachable": { "items": { "type": "string" }, "description": "Locations that could not be reached.", "type": "array" } } }, "IPs": { "id": "IPs", "properties": { "servingOnAltPorts": { "readOnly": true, "items": { "type": "string" }, "description": "Output only. The list of IP addresses, where the certificate is attached, but port 443 is not open.", "type": "array" }, "serving": { "readOnly": true, "items": { "type": "string" }, "description": "Output only. The list of IP addresses, where the certificate is attached and port 443 is open.", "type": "array" }, "resolved": { "readOnly": true, "items": { "type": "string" }, "type": "array", "description": "Output only. The list of IP addresses resolved from the domain's A/AAAA records. Can contain both ipv4 and ipv6 addresses." } }, "type": "object", "description": "IPs troubleshooting information." }, "TrustConfig": { "description": "Defines a trust config.", "type": "object", "id": "TrustConfig", "properties": { "updateTime": { "readOnly": true, "description": "Output only. The last update timestamp of a TrustConfig.", "format": "google-datetime", "type": "string" }, "etag": { "description": "This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.", "type": "string" }, "createTime": { "readOnly": true, "description": "Output only. The creation timestamp of a TrustConfig.", "format": "google-datetime", "type": "string" }, "trustStores": { "type": "array", "description": "Optional. Set of trust stores to perform validation against. This field is supported when TrustConfig is configured with Load Balancers, currently not supported for SPIFFE certificate validation. Only one TrustStore specified is currently allowed.", "items": { "$ref": "TrustStore" } }, "spiffeTrustStores": { "description": "Optional. Defines a mapping from a trust domain to a TrustStore. This is used for SPIFFE certificate validation.", "additionalProperties": { "$ref": "TrustStore" }, "type": "object" }, "labels": { "type": "object", "description": "Optional. Set of labels associated with a TrustConfig.", "additionalProperties": { "type": "string" } }, "name": { "type": "string", "description": "Identifier. A user-defined name of the trust config. TrustConfig names must be unique globally and match pattern `projects/*/locations/*/trustConfigs/*`." }, "description": { "type": "string", "description": "Optional. One or more paragraphs of text description of a TrustConfig." }, "allowlistedCertificates": { "items": { "$ref": "AllowlistedCertificate" }, "type": "array", "description": "Optional. A certificate matching an allowlisted certificate is always considered valid as long as the certificate is parseable, proof of private key possession is established, and constraints on the certificate's SAN field are met." } } }, "AllowlistedCertificate": { "description": "Defines an allowlisted certificate.", "type": "object", "id": "AllowlistedCertificate", "properties": { "pemCertificate": { "type": "string", "description": "Required. PEM certificate that is allowlisted. The certificate can be up to 5k bytes, and must be a parseable X.509 certificate." } } }, "AuthorizationAttemptInfo": { "type": "object", "description": "State of the latest attempt to authorize a domain for certificate issuance.", "id": "AuthorizationAttemptInfo", "properties": { "details": { "readOnly": true, "description": "Output only. Human readable explanation for reaching the state. Provided to help address the configuration issues. Not guaranteed to be stable. For programmatic access use FailureReason enum.", "type": "string" }, "failureReason": { "description": "Output only. Reason for failure of the authorization attempt for the domain.", "enum": [ "FAILURE_REASON_UNSPECIFIED", "CONFIG", "CAA", "RATE_LIMITED" ], "readOnly": true, "enumDescriptions": [ "FailureReason is unspecified.", "There was a problem with the user's DNS or load balancer configuration for this domain.", "Certificate issuance forbidden by an explicit CAA record for the domain or a failure to check CAA records for the domain.", "Reached a CA or internal rate-limit for the domain, e.g. for certificates per top-level private domain." ], "type": "string" }, "troubleshooting": { "readOnly": true, "$ref": "Troubleshooting", "description": "Output only. Troubleshooting information for the authorization attempt. This field is only populated if the authorization attempt failed." }, "state": { "readOnly": true, "enum": [ "STATE_UNSPECIFIED", "AUTHORIZING", "AUTHORIZED", "FAILED" ], "description": "Output only. State of the domain for managed certificate issuance.", "type": "string", "enumDescriptions": [ "State is unspecified.", "Certificate provisioning for this domain is under way. Google Cloud will attempt to authorize the domain.", "A managed certificate can be provisioned, no issues for this domain.", "Attempt to authorize the domain failed. This prevents the Managed Certificate from being issued. See `failure_reason` and `details` fields for more information." ] }, "domain": { "readOnly": true, "type": "string", "description": "Output only. Domain name of the authorization attempt." }, "attemptTime": { "readOnly": true, "description": "Output only. The timestamp, when the authorization attempt was made.", "format": "google-datetime", "type": "string" } } }, "CertificateAuthorityServiceConfig": { "id": "CertificateAuthorityServiceConfig", "properties": { "caPool": { "type": "string", "description": "Required. A CA pool resource used to issue a certificate. The CA pool string has a relative resource path following the form \"projects/{project}/locations/{location}/caPools/{ca_pool}\"." } }, "description": "Contains information required to contact CA service.", "type": "object" }, "TrustStore": { "type": "object", "description": "Defines a trust store.", "id": "TrustStore", "properties": { "trustAnchors": { "items": { "$ref": "TrustAnchor" }, "type": "array", "description": "Optional. List of Trust Anchors to be used while performing validation against a given TrustStore." }, "intermediateCas": { "type": "array", "description": "Optional. Set of intermediate CA certificates used for the path building phase of chain validation. The field is currently not supported if TrustConfig is used for the workload certificate feature.", "items": { "$ref": "IntermediateCA" } } } }, "ListOperationsResponse": { "description": "The response message for Operations.ListOperations.", "type": "object", "id": "ListOperationsResponse", "properties": { "unreachable": { "items": { "type": "string" }, "description": "Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections. For example, when attempting to list all resources across all supported locations.", "type": "array" }, "operations": { "items": { "$ref": "Operation" }, "description": "A list of operations that matches the specified filter in the request.", "type": "array" }, "nextPageToken": { "type": "string", "description": "The standard List next-page token." } } }, "GclbTarget": { "type": "object", "description": "Describes a Target Proxy that uses this Certificate Map.", "id": "GclbTarget", "properties": { "targetSslProxy": { "readOnly": true, "type": "string", "description": "Output only. This field returns the resource name in the following format: `//compute.googleapis.com/projects/*/global/targetSslProxies/*`." }, "targetHttpsProxy": { "description": "Output only. This field returns the resource name in the following format: `//compute.googleapis.com/projects/*/global/targetHttpsProxies/*`.", "type": "string", "readOnly": true }, "ipConfigs": { "readOnly": true, "items": { "$ref": "IpConfig" }, "description": "Output only. IP configurations for this Target Proxy where the Certificate Map is serving.", "type": "array" } } }, "CertificateIssuanceConfig": { "description": "CertificateIssuanceConfig specifies how to issue and manage a certificate.", "type": "object", "id": "CertificateIssuanceConfig", "properties": { "description": { "description": "Optional. One or more paragraphs of text description of a CertificateIssuanceConfig.", "type": "string" }, "keyAlgorithm": { "type": "string", "enum": [ "KEY_ALGORITHM_UNSPECIFIED", "RSA_2048", "ECDSA_P256" ], "description": "Required. The key algorithm to use when generating the private key.", "enumDescriptions": [ "Unspecified key algorithm.", "Specifies RSA with a 2048-bit modulus.", "Specifies ECDSA with curve P256." ] }, "certificateAuthorityConfig": { "$ref": "CertificateAuthorityConfig", "description": "Required. The CA that issues the workload certificate. It includes the CA address, type, authentication to CA service, etc." }, "labels": { "description": "Optional. Set of labels associated with a CertificateIssuanceConfig.", "additionalProperties": { "type": "string" }, "type": "object" }, "name": { "description": "Identifier. A user-defined name of the certificate issuance config. CertificateIssuanceConfig names must be unique globally and match pattern `projects/*/locations/*/certificateIssuanceConfigs/*`.", "type": "string" }, "rotationWindowPercentage": { "description": "Required. Specifies the percentage of elapsed time of the certificate lifetime to wait before renewing the certificate. Must be a number between 1-99, inclusive.", "format": "int32", "type": "integer" }, "createTime": { "description": "Output only. The creation timestamp of a CertificateIssuanceConfig.", "format": "google-datetime", "type": "string", "readOnly": true }, "updateTime": { "readOnly": true, "type": "string", "description": "Output only. The last update timestamp of a CertificateIssuanceConfig.", "format": "google-datetime" }, "lifetime": { "description": "Required. Workload certificate lifetime requested.", "format": "google-duration", "type": "string" } } }, "Empty": { "id": "Empty", "properties": {}, "description": "A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }", "type": "object" }, "UsedBy": { "description": "Defines a resource that uses the certificate.", "type": "object", "id": "UsedBy", "properties": { "name": { "description": "Output only. Full name of the resource https://google.aip.dev/122#full-resource-names, e.g. `//certificatemanager.googleapis.com/projects/*/locations/*/certificateMaps/*/certificateMapEntries/*` or `//compute.googleapis.com/projects/*/locations/*/targetHttpsProxies/*`.", "type": "string", "readOnly": true } } }, "IntermediateCA": { "id": "IntermediateCA", "properties": { "pemCertificate": { "description": "PEM intermediate certificate used for building up paths for validation. Each certificate provided in PEM format may occupy up to 5kB.", "type": "string" } }, "description": "Defines an intermediate CA.", "type": "object" }, "ListLocationsResponse": { "description": "The response message for Locations.ListLocations.", "type": "object", "id": "ListLocationsResponse", "properties": { "nextPageToken": { "type": "string", "description": "The standard List next-page token." }, "locations": { "type": "array", "description": "A list of locations that matches the specified filter in the request.", "items": { "$ref": "Location" } } } }, "CNAME": { "id": "CNAME", "properties": { "name": { "description": "Output only. The name of the CNAME record for the domain, equals to `dns_resource_record.name` in the corresponding `DnsAuthorization`.", "type": "string", "readOnly": true }, "expectedData": { "readOnly": true, "description": "Output only. The expected value of the CNAME record for the domain, equals to `dns_resource_record.data` in the corresponding `DnsAuthorization`.", "type": "string" }, "resolvedData": { "type": "array", "description": "Output only. The resolved CNAME chain. Empty list if the CNAME record for `CNAME.name` is not found. Otherwise the first item is the value of the CNAME record for `CNAME.name`. If the CNAME chain is longer, the second item is the value of the CNAME record for the first item, and so on.", "readOnly": true, "items": { "type": "string" } } }, "type": "object", "description": "CNAME troubleshooting information." }, "Location": { "id": "Location", "properties": { "name": { "description": "Resource name for the location, which may vary between implementations. For example: `\"projects/example-project/locations/us-east1\"`", "type": "string" }, "labels": { "type": "object", "description": "Cross-service attributes for the location. For example {\"cloud.googleapis.com/region\": \"us-east1\"}", "additionalProperties": { "type": "string" } }, "locationId": { "description": "The canonical id for this location. For example: `\"us-east1\"`.", "type": "string" }, "displayName": { "type": "string", "description": "The friendly name for this location, typically a nearby city name. For example, \"Tokyo\"." }, "metadata": { "type": "object", "description": "Service-specific metadata. For example the available capacity at the given location.", "additionalProperties": { "type": "any", "description": "Properties of the object. Contains field @type with type URL." } } }, "description": "A resource that represents a Google Cloud location.", "type": "object" }, "CertificateMapEntry": { "description": "Defines a certificate map entry.", "type": "object", "id": "CertificateMapEntry", "properties": { "createTime": { "description": "Output only. The creation timestamp of a Certificate Map Entry.", "format": "google-datetime", "type": "string", "readOnly": true }, "matcher": { "description": "A predefined matcher for particular cases, other than SNI selection.", "enumDescriptions": [ "A matcher has't been recognized.", "A primary certificate that is served when SNI wasn't specified in the request or SNI couldn't be found in the map." ], "type": "string", "enum": [ "MATCHER_UNSPECIFIED", "PRIMARY" ] }, "updateTime": { "description": "Output only. The update timestamp of a Certificate Map Entry.", "format": "google-datetime", "type": "string", "readOnly": true }, "state": { "enumDescriptions": [ "The status is undefined.", "The configuration is serving.", "Update is in progress. Some frontends may serve this configuration." ], "type": "string", "readOnly": true, "description": "Output only. A serving state of this Certificate Map Entry.", "enum": [ "SERVING_STATE_UNSPECIFIED", "ACTIVE", "PENDING" ] }, "description": { "type": "string", "description": "Optional. One or more paragraphs of text description of a certificate map entry." }, "hostname": { "description": "A Hostname (FQDN, e.g. `example.com`) or a wildcard hostname expression (`*.example.com`) for a set of hostnames with common suffix. Used as Server Name Indication (SNI) for selecting a proper certificate.", "type": "string" }, "name": { "description": "Identifier. A user-defined name of the Certificate Map Entry. Certificate Map Entry names must be unique globally and match pattern `projects/*/locations/*/certificateMaps/*/certificateMapEntries/*`.", "type": "string" }, "labels": { "description": "Optional. Set of labels associated with a Certificate Map Entry.", "additionalProperties": { "type": "string" }, "type": "object" }, "certificates": { "type": "array", "description": "Optional. A set of Certificates defines for the given `hostname`. There can be defined up to four certificates in each Certificate Map Entry. Each certificate must match pattern `projects/*/locations/*/certificates/*`.", "items": { "type": "string" } } } }, "ListTrustConfigsResponse": { "id": "ListTrustConfigsResponse", "properties": { "trustConfigs": { "description": "A list of TrustConfigs for the parent resource.", "type": "array", "items": { "$ref": "TrustConfig" } }, "unreachable": { "items": { "type": "string" }, "description": "Locations that could not be reached.", "type": "array" }, "nextPageToken": { "description": "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`.", "type": "string" } }, "type": "object", "description": "Response for the `ListTrustConfigs` method." }, "ListCertificateMapsResponse": { "description": "Response for the `ListCertificateMaps` method.", "type": "object", "id": "ListCertificateMapsResponse", "properties": { "nextPageToken": { "type": "string", "description": "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`." }, "certificateMaps": { "type": "array", "description": "A list of certificate maps for the parent resource.", "items": { "$ref": "CertificateMap" } }, "unreachable": { "items": { "type": "string" }, "type": "array", "description": "Locations that could not be reached." } } }, "ListDnsAuthorizationsResponse": { "id": "ListDnsAuthorizationsResponse", "properties": { "unreachable": { "description": "Locations that could not be reached.", "type": "array", "items": { "type": "string" } }, "dnsAuthorizations": { "description": "A list of dns authorizations for the parent resource.", "type": "array", "items": { "$ref": "DnsAuthorization" } }, "nextPageToken": { "description": "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`.", "type": "string" } }, "description": "Response for the `ListDnsAuthorizations` method.", "type": "object" }, "DnsResourceRecord": { "type": "object", "description": "The structure describing the DNS Resource Record that needs to be added to DNS configuration for the authorization to be usable by certificate.", "id": "DnsResourceRecord", "properties": { "name": { "readOnly": true, "description": "Output only. Fully qualified name of the DNS Resource Record. e.g. `_acme-challenge.example.com`", "type": "string" }, "type": { "readOnly": true, "description": "Output only. Type of the DNS Resource Record. Currently always set to \"CNAME\".", "type": "string" }, "data": { "readOnly": true, "type": "string", "description": "Output only. Data of the DNS Resource Record." } } }, "ListCertificatesResponse": { "id": "ListCertificatesResponse", "properties": { "certificates": { "items": { "$ref": "Certificate" }, "type": "array", "description": "A list of certificates for the parent resource." }, "nextPageToken": { "type": "string", "description": "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": { "description": "A list of locations that could not be reached.", "type": "array", "items": { "type": "string" } } }, "description": "Response for the `ListCertificates` method.", "type": "object" }, "ManagedCertificate": { "description": "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.", "type": "object", "id": "ManagedCertificate", "properties": { "dnsAuthorizations": { "items": { "type": "string" }, "type": "array", "description": "Optional. Immutable. Authorizations that will be used for performing domain authorization." }, "domains": { "items": { "type": "string" }, "description": "Optional. Immutable. The domains for which a managed SSL certificate will be generated. Wildcard domains are only supported with DNS challenge resolution.", "type": "array" }, "state": { "enumDescriptions": [ "State is unspecified.", "Certificate Manager attempts to provision or renew the certificate. If the process takes longer than expected, consult the `provisioning_issue` field.", "Multiple certificate provisioning attempts failed and Certificate Manager gave up. To try again, delete and create a new managed Certificate resource. For details see the `provisioning_issue` field.", "The certificate management is working, and a certificate has been provisioned." ], "type": "string", "readOnly": true, "description": "Output only. State of the managed certificate resource.", "enum": [ "STATE_UNSPECIFIED", "PROVISIONING", "FAILED", "ACTIVE" ] }, "authorizationAttemptInfo": { "readOnly": true, "items": { "$ref": "AuthorizationAttemptInfo" }, "description": "Output only. Detailed state of the latest authorization attempt for each domain specified for managed certificate resource.", "type": "array" }, "issuanceConfig": { "description": "Optional. Immutable. The resource name for a CertificateIssuanceConfig used to configure private PKI certificates in the format `projects/*/locations/*/certificateIssuanceConfigs/*`. If this field is not set, the certificates will instead be publicly signed as documented at https://cloud.google.com/load-balancing/docs/ssl-certificates/google-managed-certs#caa.", "type": "string" }, "provisioningIssue": { "description": "Output only. Information about issues with provisioning a Managed Certificate.", "readOnly": true, "$ref": "ProvisioningIssue" } } }, "SelfManagedCertificate": { "type": "object", "description": "Certificate data for a SelfManaged Certificate. SelfManaged Certificates are uploaded by the user. Updating such certificates before they expire remains the user's responsibility.", "id": "SelfManagedCertificate", "properties": { "pemPrivateKey": { "type": "string", "description": "Optional. Input only. The PEM-encoded private key of the leaf certificate." }, "pemCertificate": { "type": "string", "description": "Optional. Input only. The PEM-encoded certificate chain. Leaf certificate comes first, followed by intermediate ones if any." } } }, "CertificateAuthorityConfig": { "description": "The CA that issues the workload certificate. It includes CA address, type, authentication to CA service, etc.", "type": "object", "id": "CertificateAuthorityConfig", "properties": { "certificateAuthorityServiceConfig": { "description": "Defines a CertificateAuthorityServiceConfig.", "$ref": "CertificateAuthorityServiceConfig" } } }, "CertificateMap": { "description": "Defines a collection of certificate configurations.", "type": "object", "id": "CertificateMap", "properties": { "description": { "type": "string", "description": "Optional. One or more paragraphs of text description of a certificate map." }, "gclbTargets": { "description": "Output only. A list of GCLB targets that use this Certificate Map. A Target Proxy is only present on this list if it's attached to a Forwarding Rule.", "type": "array", "readOnly": true, "items": { "$ref": "GclbTarget" } }, "createTime": { "readOnly": true, "description": "Output only. The creation timestamp of a Certificate Map.", "format": "google-datetime", "type": "string" }, "updateTime": { "readOnly": true, "type": "string", "description": "Output only. The update timestamp of a Certificate Map.", "format": "google-datetime" }, "labels": { "type": "object", "description": "Optional. Set of labels associated with a Certificate Map.", "additionalProperties": { "type": "string" } }, "name": { "description": "Identifier. A user-defined name of the Certificate Map. Certificate Map names must be unique globally and match pattern `projects/*/locations/*/certificateMaps/*`.", "type": "string" } } } } }