Google Git
Sign in
chromium / external / github.com / google / google-api-python-client / refs/heads/release-v1.13.0 / . / googleapiclient / discovery_cache / documents / privateca.v1beta1.json
blob: 9271c84c5cdd6d505e57c7b2ae3e4404fb3bf673 [file] [log] [blame] [edit]
{
"revision": "20201112",
"name": "privateca",
"mtlsRootUrl": "https://privateca.mtls.googleapis.com/",
"baseUrl": "https://privateca.googleapis.com/",
"ownerName": "Google",
"icons": {
"x16": "http://www.google.com/images/icons/product/search-16.gif",
"x32": "http://www.google.com/images/icons/product/search-32.gif"
},
"resources": {
"projects": {
"resources": {
"locations": {
"methods": {
"get": {
"httpMethod": "GET",
"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}",
"description": "Gets information about a location.",
"parameterOrder": [
"name"
],
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"id": "privateca.projects.locations.get",
"response": {
"$ref": "Location"
},
"parameters": {
"name": {
"description": "Resource name for the location.",
"type": "string",
"pattern": "^projects/[^/]+/locations/[^/]+$",
"location": "path",
"required": true
}
},
"path": "v1beta1/{+name}"
},
"list": {
"description": "Lists information about the supported locations for this service.",
"path": "v1beta1/{+name}/locations",
"id": "privateca.projects.locations.list",
"parameters": {
"name": {
"type": "string",
"description": "The resource that owns the locations collection, if applicable.",
"location": "path",
"required": true,
"pattern": "^projects/[^/]+$"
},
"pageToken": {
"description": "The standard list page token.",
"location": "query",
"type": "string"
},
"pageSize": {
"format": "int32",
"location": "query",
"description": "The standard list page size.",
"type": "integer"
},
"filter": {
"location": "query",
"description": "The standard list filter.",
"type": "string"
}
},
"parameterOrder": [
"name"
],
"flatPath": "v1beta1/projects/{projectsId}/locations",
"httpMethod": "GET",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"response": {
"$ref": "ListLocationsResponse"
}
}
},
"resources": {
"certificateAuthorities": {
"methods": {
"patch": {
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"request": {
"$ref": "CertificateAuthority"
},
"response": {
"$ref": "Operation"
},
"description": "Update a CertificateAuthority.",
"parameterOrder": [
"name"
],
"id": "privateca.projects.locations.certificateAuthorities.patch",
"httpMethod": "PATCH",
"path": "v1beta1/{+name}",
"parameters": {
"requestId": {
"type": "string",
"location": "query",
"description": "Optional. An ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and t he request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000)."
},
"name": {
"type": "string",
"description": "Output only. The resource name for this CertificateAuthority in the format `projects/*/locations/*/certificateAuthorities/*`.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/certificateAuthorities/[^/]+$",
"required": true
},
"updateMask": {
"type": "string",
"format": "google-fieldmask",
"location": "query",
"description": "Required. A list of fields to be updated in this request."
}
},
"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/certificateAuthorities/{certificateAuthoritiesId}"
},
"getIamPolicy": {
"description": "Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.",
"id": "privateca.projects.locations.certificateAuthorities.getIamPolicy",
"response": {
"$ref": "Policy"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/certificateAuthorities/{certificateAuthoritiesId}:getIamPolicy",
"path": "v1beta1/{+resource}:getIamPolicy",
"parameters": {
"resource": {
"location": "path",
"required": true,
"pattern": "^projects/[^/]+/locations/[^/]+/certificateAuthorities/[^/]+$",
"description": "REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field.",
"type": "string"
},
"options.requestedPolicyVersion": {
"description": "Optional. The policy format version to be returned. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).",
"location": "query",
"format": "int32",
"type": "integer"
}
},
"httpMethod": "GET",
"parameterOrder": [
"resource"
]
},
"restore": {
"response": {
"$ref": "Operation"
},
"parameters": {
"name": {
"description": "Required. The resource name for this CertificateAuthority in the format `projects/*/locations/*/certificateAuthorities/*`.",
"type": "string",
"pattern": "^projects/[^/]+/locations/[^/]+/certificateAuthorities/[^/]+$",
"required": true,
"location": "path"
}
},
"httpMethod": "POST",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/certificateAuthorities/{certificateAuthoritiesId}:restore",
"path": "v1beta1/{+name}:restore",
"id": "privateca.projects.locations.certificateAuthorities.restore",
"parameterOrder": [
"name"
],
"description": "Restore a CertificateAuthority that is scheduled for deletion.",
"request": {
"$ref": "RestoreCertificateAuthorityRequest"
}
},
"enable": {
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"request": {
"$ref": "EnableCertificateAuthorityRequest"
},
"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/certificateAuthorities/{certificateAuthoritiesId}:enable",
"description": "Enable a CertificateAuthority.",
"parameters": {
"name": {
"type": "string",
"location": "path",
"description": "Required. The resource name for this CertificateAuthority in the format `projects/*/locations/*/certificateAuthorities/*`.",
"required": true,
"pattern": "^projects/[^/]+/locations/[^/]+/certificateAuthorities/[^/]+$"
}
},
"httpMethod": "POST",
"id": "privateca.projects.locations.certificateAuthorities.enable",
"response": {
"$ref": "Operation"
},
"parameterOrder": [
"name"
],
"path": "v1beta1/{+name}:enable"
},
"activate": {
"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/certificateAuthorities/{certificateAuthoritiesId}:activate",
"path": "v1beta1/{+name}:activate",
"parameterOrder": [
"name"
],
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"description": "Activate a CertificateAuthority that is in state PENDING_ACTIVATION and is of type SUBORDINATE. After the parent Certificate Authority signs a certificate signing request from FetchCertificateAuthorityCsr, this method can complete the activation process.",
"request": {
"$ref": "ActivateCertificateAuthorityRequest"
},
"response": {
"$ref": "Operation"
},
"parameters": {
"name": {
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/certificateAuthorities/[^/]+$",
"type": "string",
"description": "Required. The resource name for this CertificateAuthority in the format `projects/*/locations/*/certificateAuthorities/*`.",
"required": true
}
},
"id": "privateca.projects.locations.certificateAuthorities.activate",
"httpMethod": "POST"
},
"scheduleDelete": {
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"id": "privateca.projects.locations.certificateAuthorities.scheduleDelete",
"httpMethod": "POST",
"request": {
"$ref": "ScheduleDeleteCertificateAuthorityRequest"
},
"response": {
"$ref": "Operation"
},
"parameterOrder": [
"name"
],
"description": "Schedule a CertificateAuthority for deletion.",
"path": "v1beta1/{+name}:scheduleDelete",
"parameters": {
"name": {
"description": "Required. The resource name for this CertificateAuthority in the format `projects/*/locations/*/certificateAuthorities/*`.",
"location": "path",
"type": "string",
"required": true,
"pattern": "^projects/[^/]+/locations/[^/]+/certificateAuthorities/[^/]+$"
}
},
"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/certificateAuthorities/{certificateAuthoritiesId}:scheduleDelete"
},
"fetch": {
"parameters": {
"name": {
"type": "string",
"pattern": "^projects/[^/]+/locations/[^/]+/certificateAuthorities/[^/]+$",
"description": "Required. The resource name for this CertificateAuthority in the format `projects/*/locations/*/certificateAuthorities/*`.",
"location": "path",
"required": true
}
},
"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/certificateAuthorities/{certificateAuthoritiesId}:fetch",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"id": "privateca.projects.locations.certificateAuthorities.fetch",
"description": "Fetch a certificate signing request (CSR) from a CertificateAuthority that is in state PENDING_ACTIVATION and is of type SUBORDINATE. The CSR must then be signed by the desired parent Certificate Authority, which could be another CertificateAuthority resource, or could be an on-prem certificate authority. See also ActivateCertificateAuthority.",
"httpMethod": "GET",
"parameterOrder": [
"name"
],
"path": "v1beta1/{+name}:fetch",
"response": {
"$ref": "FetchCertificateAuthorityCsrResponse"
}
},
"create": {
"response": {
"$ref": "Operation"
},
"path": "v1beta1/{+parent}/certificateAuthorities",
"request": {
"$ref": "CertificateAuthority"
},
"parameters": {
"parent": {
"location": "path",
"description": "Required. The resource name of the location associated with the CertificateAuthorities, in the format `projects/*/locations/*`.",
"required": true,
"pattern": "^projects/[^/]+/locations/[^/]+$",
"type": "string"
},
"certificateAuthorityId": {
"location": "query",
"type": "string",
"description": "Required. It must be unique within a location and match the regular expression `[a-zA-Z0-9_-]{1,63}`"
},
"requestId": {
"description": "Optional. An ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and t he request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"httpMethod": "POST",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"parameterOrder": [
"parent"
],
"id": "privateca.projects.locations.certificateAuthorities.create",
"description": "Create a new CertificateAuthority in a given Project and Location.",
"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/certificateAuthorities"
},
"disable": {
"response": {
"$ref": "Operation"
},
"request": {
"$ref": "DisableCertificateAuthorityRequest"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"description": "Disable a CertificateAuthority.",
"httpMethod": "POST",
"parameters": {
"name": {
"pattern": "^projects/[^/]+/locations/[^/]+/certificateAuthorities/[^/]+$",
"location": "path",
"description": "Required. The resource name for this CertificateAuthority in the format `projects/*/locations/*/certificateAuthorities/*`.",
"required": true,
"type": "string"
}
},
"id": "privateca.projects.locations.certificateAuthorities.disable",
"parameterOrder": [
"name"
],
"path": "v1beta1/{+name}:disable",
"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/certificateAuthorities/{certificateAuthoritiesId}:disable"
},
"list": {
"id": "privateca.projects.locations.certificateAuthorities.list",
"response": {
"$ref": "ListCertificateAuthoritiesResponse"
},
"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/certificateAuthorities",
"path": "v1beta1/{+parent}/certificateAuthorities",
"httpMethod": "GET",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"parameterOrder": [
"parent"
],
"parameters": {
"filter": {
"location": "query",
"description": "Optional. Only include resources that match the filter in the response.",
"type": "string"
},
"pageToken": {
"location": "query",
"type": "string",
"description": "Optional. Pagination token, returned earlier via ListCertificateAuthoritiesResponse.next_page_token."
},
"pageSize": {
"type": "integer",
"location": "query",
"format": "int32",
"description": "Optional. Limit on the number of CertificateAuthorities to include in the response. Further CertificateAuthorities can subsequently be obtained by including the ListCertificateAuthoritiesResponse.next_page_token in a subsequent request. If unspecified, the server will pick an appropriate default."
},
"orderBy": {
"description": "Optional. Specify how the results should be sorted.",
"type": "string",
"location": "query"
},
"parent": {
"description": "Required. The resource name of the location associated with the CertificateAuthorities, in the format `projects/*/locations/*`.",
"location": "path",
"type": "string",
"required": true,
"pattern": "^projects/[^/]+/locations/[^/]+$"
}
},
"description": "Lists CertificateAuthorities."
},
"setIamPolicy": {
"request": {
"$ref": "SetIamPolicyRequest"
},
"description": "Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.",
"httpMethod": "POST",
"response": {
"$ref": "Policy"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"id": "privateca.projects.locations.certificateAuthorities.setIamPolicy",
"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/certificateAuthorities/{certificateAuthoritiesId}:setIamPolicy",
"path": "v1beta1/{+resource}:setIamPolicy",
"parameters": {
"resource": {
"pattern": "^projects/[^/]+/locations/[^/]+/certificateAuthorities/[^/]+$",
"location": "path",
"type": "string",
"required": true,
"description": "REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field."
}
},
"parameterOrder": [
"resource"
]
},
"get": {
"response": {
"$ref": "CertificateAuthority"
},
"parameters": {
"name": {
"pattern": "^projects/[^/]+/locations/[^/]+/certificateAuthorities/[^/]+$",
"type": "string",
"location": "path",
"required": true,
"description": "Required. The name of the CertificateAuthority to get."
}
},
"httpMethod": "GET",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"id": "privateca.projects.locations.certificateAuthorities.get",
"path": "v1beta1/{+name}",
"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/certificateAuthorities/{certificateAuthoritiesId}",
"description": "Returns a CertificateAuthority.",
"parameterOrder": [
"name"
]
},
"testIamPermissions": {
"httpMethod": "POST",
"id": "privateca.projects.locations.certificateAuthorities.testIamPermissions",
"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/certificateAuthorities/{certificateAuthoritiesId}:testIamPermissions",
"parameterOrder": [
"resource"
],
"description": "Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may \"fail open\" without warning.",
"request": {
"$ref": "TestIamPermissionsRequest"
},
"path": "v1beta1/{+resource}:testIamPermissions",
"response": {
"$ref": "TestIamPermissionsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"parameters": {
"resource": {
"required": true,
"description": "REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field.",
"pattern": "^projects/[^/]+/locations/[^/]+/certificateAuthorities/[^/]+$",
"type": "string",
"location": "path"
}
}
}
},
"resources": {
"certificates": {
"methods": {
"list": {
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/certificateAuthorities/{certificateAuthoritiesId}/certificates",
"id": "privateca.projects.locations.certificateAuthorities.certificates.list",
"path": "v1beta1/{+parent}/certificates",
"description": "Lists Certificates.",
"httpMethod": "GET",
"parameters": {
"filter": {
"type": "string",
"description": "Optional. Only include resources that match the filter in the response. For details on supported filters and syntax, see [Certificates Filtering documentation](https://cloud.google.com/certificate-authority-service/docs/sorting-filtering-certificates#filtering_support).",
"location": "query"
},
"parent": {
"type": "string",
"required": true,
"pattern": "^projects/[^/]+/locations/[^/]+/certificateAuthorities/[^/]+$",
"location": "path",
"description": "Required. The resource name of the location associated with the Certificates, in the format `projects/*/locations/*/certificateauthorities/*`."
},
"orderBy": {
"location": "query",
"description": "Optional. Specify how the results should be sorted. For details on supported fields and syntax, see [Certificates Sorting documentation](https://cloud.google.com/certificate-authority-service/docs/sorting-filtering-certificates#sorting_support).",
"type": "string"
},
"pageSize": {
"description": "Optional. Limit on the number of Certificates to include in the response. Further Certificates can subsequently be obtained by including the ListCertificatesResponse.next_page_token in a subsequent request. If unspecified, the server will pick an appropriate default.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"location": "query",
"description": "Optional. Pagination token, returned earlier via ListCertificatesResponse.next_page_token.",
"type": "string"
}
},
"response": {
"$ref": "ListCertificatesResponse"
},
"parameterOrder": [
"parent"
]
},
"patch": {
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"description": "Update a Certificate. Currently, the only field you can update is the labels field.",
"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/certificateAuthorities/{certificateAuthoritiesId}/certificates/{certificatesId}",
"response": {
"$ref": "Certificate"
},
"request": {
"$ref": "Certificate"
},
"parameters": {
"updateMask": {
"description": "Required. A list of fields to be updated in this request.",
"type": "string",
"location": "query",
"format": "google-fieldmask"
},
"name": {
"required": true,
"location": "path",
"type": "string",
"description": "Output only. The resource path for this Certificate in the format `projects/*/locations/*/certificateAuthorities/*/certificates/*`.",
"pattern": "^projects/[^/]+/locations/[^/]+/certificateAuthorities/[^/]+/certificates/[^/]+$"
},
"requestId": {
"description": "Optional. An ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and t he request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"id": "privateca.projects.locations.certificateAuthorities.certificates.patch",
"httpMethod": "PATCH",
"path": "v1beta1/{+name}",
"parameterOrder": [
"name"
]
},
"get": {
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"path": "v1beta1/{+name}",
"response": {
"$ref": "Certificate"
},
"parameters": {
"name": {
"description": "Required. The name of the Certificate to get.",
"required": true,
"type": "string",
"pattern": "^projects/[^/]+/locations/[^/]+/certificateAuthorities/[^/]+/certificates/[^/]+$",
"location": "path"
}
},
"parameterOrder": [
"name"
],
"id": "privateca.projects.locations.certificateAuthorities.certificates.get",
"httpMethod": "GET",
"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/certificateAuthorities/{certificateAuthoritiesId}/certificates/{certificatesId}",
"description": "Returns a Certificate."
},
"revoke": {
"httpMethod": "POST",
"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/certificateAuthorities/{certificateAuthoritiesId}/certificates/{certificatesId}:revoke",
"request": {
"$ref": "RevokeCertificateRequest"
},
"path": "v1beta1/{+name}:revoke",
"parameters": {
"name": {
"description": "Required. The resource name for this Certificate in the format `projects/*/locations/*/certificateAuthorities/*/certificates/*`.",
"pattern": "^projects/[^/]+/locations/[^/]+/certificateAuthorities/[^/]+/certificates/[^/]+$",
"required": true,
"type": "string",
"location": "path"
}
},
"description": "Revoke a Certificate.",
"id": "privateca.projects.locations.certificateAuthorities.certificates.revoke",
"parameterOrder": [
"name"
],
"response": {
"$ref": "Certificate"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"create": {
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/certificateAuthorities/{certificateAuthoritiesId}/certificates",
"id": "privateca.projects.locations.certificateAuthorities.certificates.create",
"request": {
"$ref": "Certificate"
},
"parameterOrder": [
"parent"
],
"path": "v1beta1/{+parent}/certificates",
"description": "Create a new Certificate in a given Project, Location from a particular CertificateAuthority.",
"parameters": {
"certificateId": {
"description": "Optional. It must be unique within a location and match the regular expression `[a-zA-Z0-9_-]{1,63}`. This field is required when using a CertificateAuthority in the Enterprise CertificateAuthority.Tier, but is optional and its value is ignored otherwise.",
"location": "query",
"type": "string"
},
"requestId": {
"location": "query",
"type": "string",
"description": "Optional. An ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and t he request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000)."
},
"parent": {
"required": true,
"type": "string",
"description": "Required. The resource name of the location and CertificateAuthority associated with the Certificate, in the format `projects/*/locations/*/certificateAuthorities/*`.",
"pattern": "^projects/[^/]+/locations/[^/]+/certificateAuthorities/[^/]+$",
"location": "path"
}
},
"httpMethod": "POST",
"response": {
"$ref": "Certificate"
}
}
}
},
"certificateRevocationLists": {
"methods": {
"get": {
"response": {
"$ref": "CertificateRevocationList"
},
"parameterOrder": [
"name"
],
"description": "Returns a CertificateRevocationList.",
"httpMethod": "GET",
"parameters": {
"name": {
"type": "string",
"pattern": "^projects/[^/]+/locations/[^/]+/certificateAuthorities/[^/]+/certificateRevocationLists/[^/]+$",
"location": "path",
"description": "Required. The name of the CertificateRevocationList to get.",
"required": true
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/certificateAuthorities/{certificateAuthoritiesId}/certificateRevocationLists/{certificateRevocationListsId}",
"id": "privateca.projects.locations.certificateAuthorities.certificateRevocationLists.get",
"path": "v1beta1/{+name}"
},
"setIamPolicy": {
"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/certificateAuthorities/{certificateAuthoritiesId}/certificateRevocationLists/{certificateRevocationListsId}:setIamPolicy",
"parameters": {
"resource": {
"required": true,
"type": "string",
"pattern": "^projects/[^/]+/locations/[^/]+/certificateAuthorities/[^/]+/certificateRevocationLists/[^/]+$",
"description": "REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field.",
"location": "path"
}
},
"id": "privateca.projects.locations.certificateAuthorities.certificateRevocationLists.setIamPolicy",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"path": "v1beta1/{+resource}:setIamPolicy",
"request": {
"$ref": "SetIamPolicyRequest"
},
"parameterOrder": [
"resource"
],
"response": {
"$ref": "Policy"
},
"httpMethod": "POST",
"description": "Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors."
},
"list": {
"parameterOrder": [
"parent"
],
"httpMethod": "GET",
"description": "Lists CertificateRevocationLists.",
"id": "privateca.projects.locations.certificateAuthorities.certificateRevocationLists.list",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/certificateAuthorities/{certificateAuthoritiesId}/certificateRevocationLists",
"parameters": {
"filter": {
"location": "query",
"type": "string",
"description": "Optional. Only include resources that match the filter in the response."
},
"orderBy": {
"description": "Optional. Specify how the results should be sorted.",
"type": "string",
"location": "query"
},
"pageSize": {
"format": "int32",
"description": "Optional. Limit on the number of CertificateRevocationLists to include in the response. Further CertificateRevocationLists can subsequently be obtained by including the ListCertificateRevocationListsResponse.next_page_token in a subsequent request. If unspecified, the server will pick an appropriate default.",
"type": "integer",
"location": "query"
},
"pageToken": {
"type": "string",
"description": "Optional. Pagination token, returned earlier via ListCertificateRevocationListsResponse.next_page_token.",
"location": "query"
},
"parent": {
"description": "Required. The resource name of the location associated with the CertificateRevocationLists, in the format `projects/*/locations/*/certificateauthorities/*`.",
"type": "string",
"required": true,
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/certificateAuthorities/[^/]+$"
}
},
"path": "v1beta1/{+parent}/certificateRevocationLists",
"response": {
"$ref": "ListCertificateRevocationListsResponse"
}
},
"testIamPermissions": {
"response": {
"$ref": "TestIamPermissionsResponse"
},
"path": "v1beta1/{+resource}:testIamPermissions",
"parameterOrder": [
"resource"
],
"id": "privateca.projects.locations.certificateAuthorities.certificateRevocationLists.testIamPermissions",
"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/certificateAuthorities/{certificateAuthoritiesId}/certificateRevocationLists/{certificateRevocationListsId}:testIamPermissions",
"request": {
"$ref": "TestIamPermissionsRequest"
},
"parameters": {
"resource": {
"required": true,
"pattern": "^projects/[^/]+/locations/[^/]+/certificateAuthorities/[^/]+/certificateRevocationLists/[^/]+$",
"location": "path",
"description": "REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field.",
"type": "string"
}
},
"description": "Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may \"fail open\" without warning.",
"httpMethod": "POST",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"getIamPolicy": {
"httpMethod": "GET",
"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/certificateAuthorities/{certificateAuthoritiesId}/certificateRevocationLists/{certificateRevocationListsId}:getIamPolicy",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"response": {
"$ref": "Policy"
},
"id": "privateca.projects.locations.certificateAuthorities.certificateRevocationLists.getIamPolicy",
"parameters": {
"options.requestedPolicyVersion": {
"description": "Optional. The policy format version to be returned. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).",
"format": "int32",
"type": "integer",
"location": "query"
},
"resource": {
"pattern": "^projects/[^/]+/locations/[^/]+/certificateAuthorities/[^/]+/certificateRevocationLists/[^/]+$",
"description": "REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field.",
"required": true,
"location": "path",
"type": "string"
}
},
"path": "v1beta1/{+resource}:getIamPolicy",
"description": "Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.",
"parameterOrder": [
"resource"
]
},
"patch": {
"id": "privateca.projects.locations.certificateAuthorities.certificateRevocationLists.patch",
"description": "Update a CertificateRevocationList.",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/certificateAuthorities/{certificateAuthoritiesId}/certificateRevocationLists/{certificateRevocationListsId}",
"request": {
"$ref": "CertificateRevocationList"
},
"httpMethod": "PATCH",
"parameters": {
"updateMask": {
"description": "Required. A list of fields to be updated in this request.",
"format": "google-fieldmask",
"type": "string",
"location": "query"
},
"requestId": {
"location": "query",
"description": "Optional. An ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and t he request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).",
"type": "string"
},
"name": {
"pattern": "^projects/[^/]+/locations/[^/]+/certificateAuthorities/[^/]+/certificateRevocationLists/[^/]+$",
"description": "Output only. The resource path for this CertificateRevocationList in the format `projects/*/locations/*/certificateAuthorities/*/ certificateRevocationLists/*`.",
"location": "path",
"required": true,
"type": "string"
}
},
"parameterOrder": [
"name"
],
"path": "v1beta1/{+name}",
"response": {
"$ref": "Operation"
}
}
}
}
}
},
"reusableConfigs": {
"methods": {
"setIamPolicy": {
"request": {
"$ref": "SetIamPolicyRequest"
},
"httpMethod": "POST",
"response": {
"$ref": "Policy"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"path": "v1beta1/{+resource}:setIamPolicy",
"parameterOrder": [
"resource"
],
"description": "Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.",
"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reusableConfigs/{reusableConfigsId}:setIamPolicy",
"id": "privateca.projects.locations.reusableConfigs.setIamPolicy",
"parameters": {
"resource": {
"location": "path",
"description": "REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field.",
"required": true,
"type": "string",
"pattern": "^projects/[^/]+/locations/[^/]+/reusableConfigs/[^/]+$"
}
}
},
"testIamPermissions": {
"path": "v1beta1/{+resource}:testIamPermissions",
"description": "Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may \"fail open\" without warning.",
"parameterOrder": [
"resource"
],
"request": {
"$ref": "TestIamPermissionsRequest"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"response": {
"$ref": "TestIamPermissionsResponse"
},
"id": "privateca.projects.locations.reusableConfigs.testIamPermissions",
"parameters": {
"resource": {
"description": "REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field.",
"required": true,
"type": "string",
"pattern": "^projects/[^/]+/locations/[^/]+/reusableConfigs/[^/]+$",
"location": "path"
}
},
"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reusableConfigs/{reusableConfigsId}:testIamPermissions",
"httpMethod": "POST"
},
"get": {
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"response": {
"$ref": "ReusableConfig"
},
"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reusableConfigs/{reusableConfigsId}",
"description": "Returns a ReusableConfig.",
"parameters": {
"name": {
"location": "path",
"description": "Required. The name of the ReusableConfigs to get.",
"type": "string",
"required": true,
"pattern": "^projects/[^/]+/locations/[^/]+/reusableConfigs/[^/]+$"
}
},
"httpMethod": "GET",
"path": "v1beta1/{+name}",
"id": "privateca.projects.locations.reusableConfigs.get",
"parameterOrder": [
"name"
]
},
"getIamPolicy": {
"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reusableConfigs/{reusableConfigsId}:getIamPolicy",
"path": "v1beta1/{+resource}:getIamPolicy",
"parameterOrder": [
"resource"
],
"parameters": {
"resource": {
"pattern": "^projects/[^/]+/locations/[^/]+/reusableConfigs/[^/]+$",
"required": true,
"location": "path",
"description": "REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field.",
"type": "string"
},
"options.requestedPolicyVersion": {
"description": "Optional. The policy format version to be returned. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).",
"type": "integer",
"location": "query",
"format": "int32"
}
},
"id": "privateca.projects.locations.reusableConfigs.getIamPolicy",
"description": "Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"httpMethod": "GET",
"response": {
"$ref": "Policy"
}
},
"list": {
"httpMethod": "GET",
"description": "Lists ReusableConfigs.",
"parameters": {
"orderBy": {
"description": "Optional. Specify how the results should be sorted.",
"location": "query",
"type": "string"
},
"parent": {
"type": "string",
"description": "Required. The resource name of the location associated with the ReusableConfigs, in the format `projects/*/locations/*`.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+$",
"required": true
},
"pageSize": {
"type": "integer",
"description": "Optional. Limit on the number of ReusableConfigs to include in the response. Further ReusableConfigs can subsequently be obtained by including the ListReusableConfigsResponse.next_page_token in a subsequent request. If unspecified, the server will pick an appropriate default.",
"format": "int32",
"location": "query"
},
"filter": {
"description": "Optional. Only include resources that match the filter in the response.",
"location": "query",
"type": "string"
},
"pageToken": {
"description": "Optional. Pagination token, returned earlier via ListReusableConfigsResponse.next_page_token.",
"location": "query",
"type": "string"
}
},
"path": "v1beta1/{+parent}/reusableConfigs",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"response": {
"$ref": "ListReusableConfigsResponse"
},
"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reusableConfigs",
"parameterOrder": [
"parent"
],
"id": "privateca.projects.locations.reusableConfigs.list"
}
}
},
"operations": {
"methods": {
"delete": {
"parameters": {
"name": {
"pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$",
"type": "string",
"description": "The name of the operation resource to be deleted.",
"required": true,
"location": "path"
}
},
"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}",
"parameterOrder": [
"name"
],
"response": {
"$ref": "Empty"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"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`.",
"id": "privateca.projects.locations.operations.delete",
"path": "v1beta1/{+name}",
"httpMethod": "DELETE"
},
"list": {
"path": "v1beta1/{+name}/operations",
"parameterOrder": [
"name"
],
"flatPath": "v1beta1/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`. NOTE: the `name` binding allows API services to override the binding to use different resource name schemes, such as `users/*/operations`. To override the binding, API services can add a binding such as `\"/v1/{name=users/*}/operations\"` to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id.",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"response": {
"$ref": "ListOperationsResponse"
},
"id": "privateca.projects.locations.operations.list",
"parameters": {
"pageToken": {
"description": "The standard list page token.",
"location": "query",
"type": "string"
},
"name": {
"pattern": "^projects/[^/]+/locations/[^/]+$",
"type": "string",
"required": true,
"description": "The name of the operation's parent resource.",
"location": "path"
},
"filter": {
"description": "The standard list filter.",
"location": "query",
"type": "string"
},
"pageSize": {
"description": "The standard list page size.",
"format": "int32",
"type": "integer",
"location": "query"
}
},
"httpMethod": "GET"
},
"cancel": {
"response": {
"$ref": "Empty"
},
"parameterOrder": [
"name"
],
"path": "v1beta1/{+name}:cancel",
"id": "privateca.projects.locations.operations.cancel",
"request": {
"$ref": "CancelOperationRequest"
},
"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`.",
"httpMethod": "POST",
"parameters": {
"name": {
"location": "path",
"required": true,
"description": "The name of the operation resource to be cancelled.",
"pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$",
"type": "string"
}
},
"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"get": {
"path": "v1beta1/{+name}",
"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}",
"parameterOrder": [
"name"
],
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"id": "privateca.projects.locations.operations.get",
"httpMethod": "GET",
"parameters": {
"name": {
"pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$",
"type": "string",
"location": "path",
"description": "The name of the operation resource.",
"required": true
}
},
"response": {
"$ref": "Operation"
},
"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."
}
}
}
}
}
}
}
},
"ownerDomain": "google.com",
"version": "v1beta1",
"title": "Certificate Authority API",
"version_module": true,
"canonicalName": "Certificate Authority Service",
"batchPath": "batch",
"rootUrl": "https://privateca.googleapis.com/",
"parameters": {
"uploadType": {
"location": "query",
"description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
"type": "string"
},
"oauth_token": {
"location": "query",
"description": "OAuth 2.0 token for the current user.",
"type": "string"
},
"alt": {
"enum": [
"json",
"media",
"proto"
],
"type": "string",
"location": "query",
"enumDescriptions": [
"Responses with Content-Type of application/json",
"Media download with context-dependent Content-Type",
"Responses with Content-Type of application/x-protobuf"
],
"default": "json",
"description": "Data format for response."
},
"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"
},
"access_token": {
"location": "query",
"type": "string",
"description": "OAuth access token."
},
"key": {
"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.",
"type": "string",
"location": "query"
},
"callback": {
"type": "string",
"description": "JSONP",
"location": "query"
},
"prettyPrint": {
"description": "Returns response with indentations and line breaks.",
"location": "query",
"type": "boolean",
"default": "true"
},
"upload_protocol": {
"location": "query",
"type": "string",
"description": "Upload protocol for media (e.g. \"raw\", \"multipart\")."
},
"fields": {
"description": "Selector specifying which fields to include in a partial response.",
"type": "string",
"location": "query"
},
"$.xgafv": {
"type": "string",
"location": "query",
"enum": [
"1",
"2"
],
"enumDescriptions": [
"v1 error format",
"v2 error format"
],
"description": "V1 error format."
}
},
"basePath": "",
"protocol": "rest",
"kind": "discovery#restDescription",
"documentationLink": "https://cloud.google.com/",
"auth": {
"oauth2": {
"scopes": {
"https://www.googleapis.com/auth/cloud-platform": {
"description": "View and manage your data across Google Cloud Platform services"
}
}
}
},
"id": "privateca:v1beta1",
"fullyEncodeReservedExpansion": true,
"servicePath": "",
"schemas": {
"RevokedCertificate": {
"description": "Describes a revoked Certificate.",
"properties": {
"revocationReason": {
"description": "The reason the Certificate was revoked.",
"type": "string",
"enumDescriptions": [
"Default unspecified value. This value does indicate that a Certificate has been revoked, but that a reason has not been recorded.",
"Key material for this Certificate may have leaked.",
"The key material for a certificate authority in the issuing path may have leaked.",
"The subject or other attributes in this Certificate have changed.",
"This Certificate has been superseded.",
"This Certificate or entities in the issuing path have ceased to operate.",
"This Certificate should not be considered valid, it is expected that it may become valid in the future.",
"This Certificate no longer has permission to assert the listed attributes.",
"The authority which determines appropriate attributes for a Certificate may have been compromised."
],
"enum": [
"REVOCATION_REASON_UNSPECIFIED",
"KEY_COMPROMISE",
"CERTIFICATE_AUTHORITY_COMPROMISE",
"AFFILIATION_CHANGED",
"SUPERSEDED",
"CESSATION_OF_OPERATION",
"CERTIFICATE_HOLD",
"PRIVILEGE_WITHDRAWN",
"ATTRIBUTE_AUTHORITY_COMPROMISE"
]
},
"certificate": {
"description": "The resource path for the Certificate in the format `projects/*/locations/*/certificateAuthorities/*/certificates/*`.",
"type": "string"
},
"hexSerialNumber": {
"description": "The serial number of the Certificate.",
"type": "string"
}
},
"type": "object",
"id": "RevokedCertificate"
},
"RevokeCertificateRequest": {
"type": "object",
"description": "Request message for CertificateAuthorityService.RevokeCertificate.",
"properties": {
"requestId": {
"type": "string",
"description": "Optional. An ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and t he request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000)."
},
"reason": {
"enum": [
"REVOCATION_REASON_UNSPECIFIED",
"KEY_COMPROMISE",
"CERTIFICATE_AUTHORITY_COMPROMISE",
"AFFILIATION_CHANGED",
"SUPERSEDED",
"CESSATION_OF_OPERATION",
"CERTIFICATE_HOLD",
"PRIVILEGE_WITHDRAWN",
"ATTRIBUTE_AUTHORITY_COMPROMISE"
],
"type": "string",
"description": "Required. The RevocationReason for revoking this certificate.",
"enumDescriptions": [
"Default unspecified value. This value does indicate that a Certificate has been revoked, but that a reason has not been recorded.",
"Key material for this Certificate may have leaked.",
"The key material for a certificate authority in the issuing path may have leaked.",
"The subject or other attributes in this Certificate have changed.",
"This Certificate has been superseded.",
"This Certificate or entities in the issuing path have ceased to operate.",
"This Certificate should not be considered valid, it is expected that it may become valid in the future.",
"This Certificate no longer has permission to assert the listed attributes.",
"The authority which determines appropriate attributes for a Certificate may have been compromised."
]
}
},
"id": "RevokeCertificateRequest"
},
"ListReusableConfigsResponse": {
"type": "object",
"id": "ListReusableConfigsResponse",
"properties": {
"reusableConfigs": {
"items": {
"$ref": "ReusableConfig"
},
"type": "array",
"description": "The list of ReusableConfigs."
},
"unreachable": {
"type": "array",
"description": "A list of locations (e.g. \"us-west1\") that could not be reached.",
"items": {
"type": "string"
}
},
"nextPageToken": {
"type": "string",
"description": "A token to retrieve next page of results. Pass this value in ListReusableConfigsRequest.next_page_token to retrieve the next page of results."
}
},
"description": "Response message for CertificateAuthorityService.ListReusableConfigs."
},
"CertificateAuthorityPolicy": {
"description": "The issuing policy for a CertificateAuthority. Certificates will not be successfully issued from this CertificateAuthority if they violate the policy.",
"id": "CertificateAuthorityPolicy",
"properties": {
"allowedSans": {
"description": "Optional. If a AllowedSubjectAltNames is specified here, then all Certificates issued by the CertificateAuthority must match AllowedSubjectAltNames. If no value or an empty value is specified, any value will be allowed for the SubjectAltNames field.",
"$ref": "AllowedSubjectAltNames"
},
"allowedIssuanceModes": {
"description": "Optional. If specified, then only methods allowed in the IssuanceModes may be used to issue Certificates.",
"$ref": "IssuanceModes"
},
"maximumLifetime": {
"format": "google-duration",
"type": "string",
"description": "Optional. The maximum lifetime allowed by the CertificateAuthority. Note that if the any part if the issuing chain expires before a Certificate's requested maximum_lifetime, the effective lifetime will be explicitly truncated."
},
"allowedCommonNames": {
"description": "Optional. If any value is specified here, then all Certificates issued by the CertificateAuthority must match at least one listed value. If no value is specified, all values will be allowed for this fied. Glob patterns are also supported.",
"type": "array",
"items": {
"type": "string"
}
},
"overwriteConfigValues": {
"description": "Optional. All Certificates issued by the CertificateAuthority will use the provided configuration values, overwriting any requested configuration values.",
"$ref": "ReusableConfigWrapper"
},
"allowedLocationsAndOrganizations": {
"type": "array",
"description": "Optional. If any Subject is specified here, then all Certificates issued by the CertificateAuthority must match at least one listed Subject. If a Subject has an empty field, any value will be allowed for that field.",
"items": {
"$ref": "Subject"
}
},
"allowedConfigList": {
"description": "Optional. All Certificates issued by the CertificateAuthority must match at least one listed ReusableConfigWrapper in the list.",
"$ref": "AllowedConfigList"
}
},
"type": "object"
},
"CertificateFingerprint": {
"type": "object",
"description": "A group of fingerprints for the x509 certificate.",
"id": "CertificateFingerprint",
"properties": {
"sha256Hash": {
"description": "The SHA 256 hash, encoded in hexadecimal, of the DER x509 certificate.",
"type": "string"
}
}
},
"TestIamPermissionsResponse": {
"id": "TestIamPermissionsResponse",
"description": "Response message for `TestIamPermissions` method.",
"type": "object",
"properties": {
"permissions": {
"description": "A subset of `TestPermissionsRequest.permissions` that the caller is allowed.",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"ListCertificateAuthoritiesResponse": {
"id": "ListCertificateAuthoritiesResponse",
"type": "object",
"description": "Response message for CertificateAuthorityService.ListCertificateAuthorities.",
"properties": {
"nextPageToken": {
"type": "string",
"description": "A token to retrieve next page of results. Pass this value in ListCertificateAuthoritiesRequest.next_page_token to retrieve the next page of results."
},
"certificateAuthorities": {
"description": "The list of CertificateAuthorities.",
"items": {
"$ref": "CertificateAuthority"
},
"type": "array"
},
"unreachable": {
"type": "array",
"description": "A list of locations (e.g. \"us-west1\") that could not be reached.",
"items": {
"type": "string"
}
}
}
},
"IssuanceModes": {
"type": "object",
"id": "IssuanceModes",
"description": "IssuanceModes specifies the allowed ways in which Certificates may be requested from this CertificateAuthority.",
"properties": {
"allowConfigBasedIssuance": {
"type": "boolean",
"description": "Required. When true, allows callers to create Certificates by specifying a CertificateConfig."
},
"allowCsrBasedIssuance": {
"description": "Required. When true, allows callers to create Certificates by specifying a CSR.",
"type": "boolean"
}
}
},
"CaOptions": {
"type": "object",
"description": "Describes values that are relevant in a CA certificate.",
"properties": {
"maxIssuerPathLength": {
"type": "integer",
"description": "Optional. Refers to the path length restriction X.509 extension. For a CA certificate, this value describes the depth of subordinate CA certificates that are allowed. If this value is less than 0, the request will fail. If this value is missing, the max path length will be omitted from the CA certificate.",
"format": "int32"
},
"isCa": {
"type": "boolean",
"description": "Optional. Refers to the \"CA\" X.509 extension, which is a boolean value. When this value is missing, the extension will be omitted from the CA certificate."
}
},
"id": "CaOptions"
},
"CertificateAuthority": {
"id": "CertificateAuthority",
"type": "object",
"properties": {
"keySpec": {
"$ref": "KeyVersionSpec",
"description": "Required. Immutable. Used when issuing certificates for this CertificateAuthority. If this CertificateAuthority is a self-signed CertificateAuthority, this key is also used to sign the self-signed CA certificate. Otherwise, it is used to sign a CSR."
},
"issuingOptions": {
"description": "Optional. The IssuingOptions to follow when issuing Certificates from this CertificateAuthority.",
"$ref": "IssuingOptions"
},
"subordinateConfig": {
"$ref": "SubordinateConfig",
"description": "Optional. If this is a subordinate CertificateAuthority, this field will be set with the subordinate configuration, which describes its issuers. This may be updated, but this CertificateAuthority must continue to validate."
},
"deleteTime": {
"format": "google-datetime",
"type": "string",
"readOnly": true,
"description": "Output only. The time at which this CertificateAuthority will be deleted, if scheduled for deletion."
},
"type": {
"enumDescriptions": [
"Not specified.",
"Self-signed CA.",
"Subordinate CA. Could be issued by a Private CA CertificateAuthority or an unmanaged CA."
],
"enum": [
"TYPE_UNSPECIFIED",
"SELF_SIGNED",
"SUBORDINATE"
],
"type": "string",
"description": "Required. Immutable. The Type of this CertificateAuthority."
},
"lifetime": {
"type": "string",
"format": "google-duration",
"description": "Required. The desired lifetime of the CA certificate. Used to create the \"not_before_time\" and \"not_after_time\" fields inside an X.509 certificate."
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Optional. Labels with user-defined metadata.",
"type": "object"
},
"caCertificateDescriptions": {
"readOnly": true,
"description": "Output only. A structured description of this CertificateAuthority's CA certificate and its issuers. Ordered as self-to-root.",
"type": "array",
"items": {
"$ref": "CertificateDescription"
}
},
"state": {
"readOnly": true,
"enum": [
"STATE_UNSPECIFIED",
"ENABLED",
"DISABLED",
"PENDING_ACTIVATION",
"PENDING_DELETION"
],
"type": "string",
"enumDescriptions": [
"Not specified.",
"Certificates can be issued from this CA. CRLs will be generated for this CA.",
"Certificates cannot be issued from this CA. CRLs will still be generated.",
"Certificates cannot be issued from this CA. CRLs will not be generated.",
"Certificates cannot be issued from this CA. CRLs will not be generated."
],
"description": "Output only. The State for this CertificateAuthority."
},
"gcsBucket": {
"type": "string",
"description": "Immutable. The name of a Cloud Storage bucket where this CertificateAuthority will publish content, such as the CA certificate and CRLs. This must be a bucket name, without any prefixes (such as `gs://`) or suffixes (such as `.googleapis.com`). For example, to use a bucket named `my-bucket`, you would simply specify `my-bucket`. If not specified, a managed bucket will be created."
},
"config": {
"description": "Required. Immutable. The config used to create a self-signed X.509 certificate or CSR.",
"$ref": "CertificateConfig"
},
"certificatePolicy": {
"description": "Optional. The CertificateAuthorityPolicy to enforce when issuing Certificates from this CertificateAuthority.",
"$ref": "CertificateAuthorityPolicy"
},
"pemCaCertificates": {
"type": "array",
"description": "Output only. This CertificateAuthority's certificate chain, including the current CertificateAuthority's certificate. Ordered such that the root issuer is the final element (consistent with RFC 5246). For a self-signed CA, this will only list the current CertificateAuthority's certificate.",
"items": {
"type": "string"
},
"readOnly": true
},
"createTime": {
"format": "google-datetime",
"readOnly": true,
"type": "string",
"description": "Output only. The time at which this CertificateAuthority was created."
},
"accessUrls": {
"readOnly": true,
"$ref": "AccessUrls",
"description": "Output only. URLs for accessing content published by this CA, such as the CA certificate and CRLs."
},
"updateTime": {
"type": "string",
"description": "Output only. The time at which this CertificateAuthority was updated.",
"format": "google-datetime",
"readOnly": true
},
"name": {
"description": "Output only. The resource name for this CertificateAuthority in the format `projects/*/locations/*/certificateAuthorities/*`.",
"readOnly": true,
"type": "string"
},
"tier": {
"enumDescriptions": [
"Not specified.",
"Enterprise tier.",
"DevOps tier."
],
"type": "string",
"description": "Required. Immutable. The Tier of this CertificateAuthority.",
"enum": [
"TIER_UNSPECIFIED",
"ENTERPRISE",
"DEVOPS"
]
}
},
"description": "A CertificateAuthority represents an individual Certificate Authority. A CertificateAuthority can be used to create Certificates."
},
"IssuingOptions": {
"type": "object",
"description": "Options that affect all certificates issued by a CertificateAuthority.",
"properties": {
"includeCrlAccessUrl": {
"type": "boolean",
"description": "Required. When true, includes a URL to the CRL corresponding to certificates issued from a CertificateAuthority. CRLs will expire 7 days from their creation. However, we will rebuild daily. CRLs are also rebuilt shortly after a certificate is revoked."
},
"includeCaCertUrl": {
"description": "Required. When true, includes a URL to the issuing CA certificate in the \"authority information access\" X.509 extension.",
"type": "boolean"
}
},
"id": "IssuingOptions"
},
"CertificateConfig": {
"type": "object",
"id": "CertificateConfig",
"description": "A CertificateConfig describes an X.509 certificate or CSR that is to be created, as an alternative to using ASN.1.",
"properties": {
"publicKey": {
"$ref": "PublicKey",
"description": "Optional. The public key that corresponds to this config. This is, for example, used when issuing Certificates, but not when creating a self-signed CertificateAuthority or CertificateAuthority CSR."
},
"subjectConfig": {
"$ref": "SubjectConfig",
"description": "Required. Specifies some of the values in a certificate that are related to the subject."
},
"reusableConfig": {
"$ref": "ReusableConfigWrapper",
"description": "Required. Describes how some of the technical fields in a certificate should be populated."
}
}
},
"Certificate": {
"description": "A Certificate corresponds to a signed X.509 certificate issued by a CertificateAuthority.",
"properties": {
"labels": {
"description": "Optional. Labels with user-defined metadata.",
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"config": {
"description": "Immutable. A description of the certificate and key that does not require X.509 or ASN.1.",
"$ref": "CertificateConfig"
},
"lifetime": {
"format": "google-duration",
"type": "string",
"description": "Required. Immutable. The desired lifetime of a certificate. Used to create the \"not_before_time\" and \"not_after_time\" fields inside an X.509 certificate. Note that the lifetime may be truncated if it would extend past the life of any certificate authority in the issuing chain."
},
"updateTime": {
"type": "string",
"description": "Output only. The time at which this Certificate was updated.",
"readOnly": true,
"format": "google-datetime"
},
"pemCertificate": {
"description": "Output only. The pem-encoded, signed X.509 certificate.",
"readOnly": true,
"type": "string"
},
"revocationDetails": {
"$ref": "RevocationDetails",
"readOnly": true,
"description": "Output only. Details regarding the revocation of this Certificate. This Certificate is considered revoked if and only if this field is present."
},
"certificateDescription": {
"$ref": "CertificateDescription",
"description": "Output only. A structured description of the issued X.509 certificate.",
"readOnly": true
},
"createTime": {
"description": "Output only. The time at which this Certificate was created.",
"readOnly": true,
"type": "string",
"format": "google-datetime"
},
"pemCertificateChain": {
"items": {
"type": "string"
},
"description": "Output only. The chain that may be used to verify the X.509 certificate. Expected to be in issuer-to-root order according to RFC 5246.",
"type": "array",
"readOnly": true
},
"pemCsr": {
"description": "Immutable. A pem-encoded X.509 certificate signing request (CSR).",
"type": "string"
},
"name": {
"readOnly": true,
"type": "string",
"description": "Output only. The resource path for this Certificate in the format `projects/*/locations/*/certificateAuthorities/*/certificates/*`."
}
},
"type": "object",
"id": "Certificate"
},
"ListLocationsResponse": {
"id": "ListLocationsResponse",
"description": "The response message for Locations.ListLocations.",
"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"
}
}
},
"type": "object"
},
"ReusableConfig": {
"type": "object",
"description": "A ReusableConfig refers to a managed ReusableConfigValues. Those, in turn, are used to describe certain fields of an X.509 certificate, such as the key usage fields, fields specific to CA certificates, certificate policy extensions and custom extensions.",
"properties": {
"updateTime": {
"readOnly": true,
"type": "string",
"description": "Output only. The time at which this ReusableConfig was updated.",
"format": "google-datetime"
},
"createTime": {
"format": "google-datetime",
"description": "Output only. The time at which this ReusableConfig was created.",
"type": "string",
"readOnly": true
},
"name": {
"type": "string",
"readOnly": true,
"description": "Output only. The resource path for this ReusableConfig in the format `projects/*/locations/*/reusableConfigs/*`."
},
"values": {
"$ref": "ReusableConfigValues",
"description": "Required. The config values."
},
"description": {
"type": "string",
"description": "Optional. A human-readable description of scenarios these ReusableConfigValues may be compatible with."
},
"labels": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "Optional. Labels with user-defined metadata."
}
},
"id": "ReusableConfig"
},
"KeyUsage": {
"id": "KeyUsage",
"description": "A KeyUsage describes key usage values that may appear in an X.509 certificate.",
"type": "object",
"properties": {
"extendedKeyUsage": {
"$ref": "ExtendedKeyUsageOptions",
"description": "Detailed scenarios in which a key may be used."
},
"baseKeyUsage": {
"description": "Describes high-level ways in which a key may be used.",
"$ref": "KeyUsageOptions"
},
"unknownExtendedKeyUsages": {
"description": "Used to describe extended key usages that are not listed in the KeyUsage.ExtendedKeyUsageOptions message.",
"type": "array",
"items": {
"$ref": "ObjectId"
}
}
}
},
"ExtendedKeyUsageOptions": {
"type": "object",
"id": "ExtendedKeyUsageOptions",
"description": "KeyUsage.ExtendedKeyUsageOptions has fields that correspond to certain common OIDs that could be specified as an extended key usage value.",
"properties": {
"clientAuth": {
"type": "boolean",
"description": "Corresponds to OID 1.3.6.1.5.5.7.3.2. Officially described as \"TLS WWW client authentication\", though regularly used for non-WWW TLS."
},
"timeStamping": {
"type": "boolean",
"description": "Corresponds to OID 1.3.6.1.5.5.7.3.8. Officially described as \"Binding the hash of an object to a time\"."
},
"codeSigning": {
"description": "Corresponds to OID 1.3.6.1.5.5.7.3.3. Officially described as \"Signing of downloadable executable code client authentication\".",
"type": "boolean"
},
"serverAuth": {
"description": "Corresponds to OID 1.3.6.1.5.5.7.3.1. Officially described as \"TLS WWW server authentication\", though regularly used for non-WWW TLS.",
"type": "boolean"
},
"emailProtection": {
"description": "Corresponds to OID 1.3.6.1.5.5.7.3.4. Officially described as \"Email protection\".",
"type": "boolean"
},
"ocspSigning": {
"type": "boolean",
"description": "Corresponds to OID 1.3.6.1.5.5.7.3.9. Officially described as \"Signing OCSP responses\"."
}
}
},
"FetchCertificateAuthorityCsrResponse": {
"id": "FetchCertificateAuthorityCsrResponse",
"properties": {
"pemCsr": {
"description": "Output only. The PEM-encoded signed certificate signing request (CSR).",
"type": "string",
"readOnly": true
}
},
"type": "object",
"description": "Response message for CertificateAuthorityService.FetchCertificateAuthorityCsr."
},
"CertificateRevocationList": {
"properties": {
"sequenceNumber": {
"description": "Output only. The CRL sequence number that appears in pem_crl.",
"format": "int64",
"readOnly": true,
"type": "string"
},
"updateTime": {
"description": "Output only. The time at which this CertificateRevocationList was updated.",
"type": "string",
"format": "google-datetime",
"readOnly": true
},
"state": {
"enumDescriptions": [
"Not specified.",
"The CertificateRevocationList is up to date.",
"The CertificateRevocationList is no longer current."
],
"type": "string",
"description": "Output only. The State for this CertificateRevocationList.",
"readOnly": true,
"enum": [
"STATE_UNSPECIFIED",
"ACTIVE",
"SUPERSEDED"
]
},
"createTime": {
"description": "Output only. The time at which this CertificateRevocationList was created.",
"readOnly": true,
"type": "string",
"format": "google-datetime"
},
"revokedCertificates": {
"type": "array",
"description": "Output only. The revoked serial numbers that appear in pem_crl.",
"items": {
"$ref": "RevokedCertificate"
},
"readOnly": true
},
"name": {
"type": "string",
"description": "Output only. The resource path for this CertificateRevocationList in the format `projects/*/locations/*/certificateAuthorities/*/ certificateRevocationLists/*`.",
"readOnly": true
},
"labels": {
"additionalProperties": {
"type": "string"
},
"type": "object",
"description": "Optional. Labels with user-defined metadata."
},
"accessUrl": {
"description": "Output only. The location where 'pem_crl' can be accessed.",
"type": "string",
"readOnly": true
},
"pemCrl": {
"description": "Output only. The PEM-encoded X.509 CRL.",
"type": "string",
"readOnly": true
}
},
"type": "object",
"id": "CertificateRevocationList",
"description": "A CertificateRevocationList corresponds to a signed X.509 certificate Revocation List (CRL). A CRL contains the serial numbers of certificates that should no longer be trusted."
},
"Binding": {
"id": "Binding",
"properties": {
"condition": {
"$ref": "Expr",
"description": "The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the members in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies)."
},
"role": {
"description": "Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.",
"type": "string"
},
"members": {
"description": "Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `[email protected]` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `[email protected]`. * `group:{emailid}`: An email address that represents a Google group. For example, `[email protected]`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `[email protected]?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `[email protected]?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `[email protected]?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. ",
"type": "array",
"items": {
"type": "string"
}
}
},
"type": "object",
"description": "Associates `members` with a `role`."
},
"Expr": {
"id": "Expr",
"properties": {
"title": {
"description": "Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.",
"type": "string"
},
"expression": {
"type": "string",
"description": "Textual representation of an expression in Common Expression Language syntax."
},
"description": {
"type": "string",
"description": "Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI."
},
"location": {
"description": "Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.",
"type": "string"
}
},
"type": "object",
"description": "Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: \"Summary size limit\" description: \"Determines if a summary is less than 100 chars\" expression: \"document.summary.size() \u003c 100\" Example (Equality): title: \"Requestor is owner\" description: \"Determines if requestor is the document owner\" expression: \"document.owner == request.auth.claims.email\" Example (Logic): title: \"Public documents\" description: \"Determine whether the document should be publicly visible\" expression: \"document.type != 'private' && document.type != 'internal'\" Example (Data Manipulation): title: \"Notification string\" description: \"Create a notification string with a timestamp.\" expression: \"'New message received at ' + string(document.create_time)\" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information."
},
"KeyVersionSpec": {
"type": "object",
"description": "A Cloud KMS key configuration that a CertificateAuthority will use.",
"properties": {
"algorithm": {
"enum": [
"SIGN_HASH_ALGORITHM_UNSPECIFIED",
"RSA_PSS_2048_SHA256",
"RSA_PSS_3072_SHA256",
"RSA_PSS_4096_SHA256",
"RSA_PKCS1_2048_SHA256",
"RSA_PKCS1_3072_SHA256",
"RSA_PKCS1_4096_SHA256",
"EC_P256_SHA256",
"EC_P384_SHA384"
],
"description": "Required. The algorithm to use for creating a managed Cloud KMS key for a for a simplified experience. All managed keys will be have their ProtectionLevel as `HSM`.",
"type": "string",
"enumDescriptions": [
"Not specified.",
"maps to CryptoKeyVersionAlgorithm.RSA_SIGN_PSS_2048_SHA256",
"maps to CryptoKeyVersionAlgorithm. RSA_SIGN_PSS_3072_SHA256",
"maps to CryptoKeyVersionAlgorithm.RSA_SIGN_PSS_4096_SHA256",
"maps to CryptoKeyVersionAlgorithm.RSA_SIGN_PKCS1_2048_SHA256",
"maps to CryptoKeyVersionAlgorithm.RSA_SIGN_PKCS1_3072_SHA256",
"maps to CryptoKeyVersionAlgorithm.RSA_SIGN_PKCS1_4096_SHA256",
"maps to CryptoKeyVersionAlgorithm.EC_SIGN_P256_SHA256",
"maps to CryptoKeyVersionAlgorithm.EC_SIGN_P384_SHA384"
]
},
"cloudKmsKeyVersion": {
"description": "Required. The resource name for an existing Cloud KMS CryptoKeyVersion in the format `projects/*/locations/*/keyRings/*/cryptoKeys/*/cryptoKeyVersions/*`. This option enables full flexibility in the key's capabilities and properties.",
"type": "string"
}
},
"id": "KeyVersionSpec"
},
"KeyUsageOptions": {
"id": "KeyUsageOptions",
"type": "object",
"description": "KeyUsage.KeyUsageOptions corresponds to the key usage values described in https://tools.ietf.org/html/rfc5280#section-4.2.1.3.",
"properties": {
"crlSign": {
"type": "boolean",
"description": "The key may be used sign certificate revocation lists."
},
"keyEncipherment": {
"description": "The key may be used to encipher other keys.",
"type": "boolean"
},
"dataEncipherment": {
"description": "The key may be used to encipher data.",
"type": "boolean"
},
"contentCommitment": {
"type": "boolean",
"description": "The key may be used for cryptographic commitments. Note that this may also be referred to as \"non-repudiation\"."
},
"decipherOnly": {
"description": "The key may be used to decipher only.",
"type": "boolean"
},
"certSign": {
"description": "The key may be used to sign certificates.",
"type": "boolean"
},
"encipherOnly": {
"type": "boolean",
"description": "The key may be used to encipher only."
},
"keyAgreement": {
"description": "The key may be used in a key agreement protocol.",
"type": "boolean"
},
"digitalSignature": {
"type": "boolean",
"description": "The key may be used for digital signatures."
}
}
},
"SubjectConfig": {
"description": "These values are used to create the distinguished name and subject alternative name fields in an X.509 certificate.",
"properties": {
"subject": {
"description": "Required. Contains distinguished name fields such as the location and organization.",
"$ref": "Subject"
},
"commonName": {
"description": "Optional. The \"common name\" of the distinguished name.",
"type": "string"
},
"subjectAltName": {
"$ref": "SubjectAltNames",
"description": "Optional. The subject alternative name fields."
}
},
"type": "object",
"id": "SubjectConfig"
},
"SubjectDescription": {
"properties": {
"commonName": {
"description": "The \"common name\" of the distinguished name.",
"type": "string"
},
"notBeforeTime": {
"type": "string",
"format": "google-datetime",
"description": "The time at which the certificate becomes valid."
},
"subject": {
"$ref": "Subject",
"description": "Contains distinguished name fields such as the location and organization."
},
"lifetime": {
"format": "google-duration",
"type": "string",
"description": "For convenience, the actual lifetime of an issued certificate. Corresponds to 'not_after_time' - 'not_before_time'."
},
"notAfterTime": {
"type": "string",
"format": "google-datetime",
"description": "The time at which the certificate expires."
},
"hexSerialNumber": {
"type": "string",
"description": "The serial number encoded in lowercase hexadecimal."
},
"subjectAltName": {
"$ref": "SubjectAltNames",
"description": "The subject alternative name fields."
}
},
"id": "SubjectDescription",
"type": "object",
"description": "These values describe fields in an issued X.509 certificate such as the distinguished name, subject alternative names, serial number, and lifetime."
},
"ReusableConfigValues": {
"properties": {
"keyUsage": {
"$ref": "KeyUsage",
"description": "Optional. Indicates the intended use for keys that correspond to a certificate."
},
"policyIds": {
"type": "array",
"description": "Optional. Describes the X.509 certificate policy object identifiers, per https://tools.ietf.org/html/rfc5280#section-4.2.1.4.",
"items": {
"$ref": "ObjectId"
}
},
"caOptions": {
"$ref": "CaOptions",
"description": "Optional. Describes options in this ReusableConfigValues that are relevant in a CA certificate."
},
"aiaOcspServers": {
"type": "array",
"description": "Optional. Describes Online Certificate Status Protocol (OCSP) endpoint addresses that appear in the \"Authority Information Access\" extension in the certificate.",
"items": {
"type": "string"
}
},
"additionalExtensions": {
"description": "Optional. Describes custom X.509 extensions.",
"items": {
"$ref": "X509Extension"
},
"type": "array"
}
},
"description": "A ReusableConfigValues is used to describe certain fields of an X.509 certificate, such as the key usage fields, fields specific to CA certificates, certificate policy extensions and custom extensions.",
"id": "ReusableConfigValues",
"type": "object"
},
"CancelOperationRequest": {
"description": "The request message for Operations.CancelOperation.",
"properties": {},
"id": "CancelOperationRequest",
"type": "object"
},
"ActivateCertificateAuthorityRequest": {
"description": "Request message for CertificateAuthorityService.ActivateCertificateAuthority.",
"id": "ActivateCertificateAuthorityRequest",
"type": "object",
"properties": {
"pemCaCertificate": {
"type": "string",
"description": "Required. The signed CA certificate issued from FetchCertificateAuthorityCsrResponse.pem_csr."
},
"subordinateConfig": {
"$ref": "SubordinateConfig",
"description": "Required. Must include information about the issuer of 'pem_ca_certificate', and any further issuers until the self-signed CA."
},
"requestId": {
"type": "string",
"description": "Optional. An ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and t he request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000)."
}
}
},
"ObjectId": {
"description": "An ObjectId specifies an object identifier (OID). These provide context and describe types in ASN.1 messages.",
"properties": {
"objectIdPath": {
"type": "array",
"description": "Required. The parts of an OID path. The most significant parts of the path come first.",
"items": {
"format": "int32",
"type": "integer"
}
}
},
"id": "ObjectId",
"type": "object"
},
"AuditConfig": {
"description": "Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { \"audit_configs\": [ { \"service\": \"allServices\", \"audit_log_configs\": [ { \"log_type\": \"DATA_READ\", \"exempted_members\": [ \"user:[email protected]\" ] }, { \"log_type\": \"DATA_WRITE\" }, { \"log_type\": \"ADMIN_READ\" } ] }, { \"service\": \"sampleservice.googleapis.com\", \"audit_log_configs\": [ { \"log_type\": \"DATA_READ\" }, { \"log_type\": \"DATA_WRITE\", \"exempted_members\": [ \"user:[email protected]\" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts [email protected] from DATA_READ logging, and [email protected] from DATA_WRITE logging.",
"id": "AuditConfig",
"type": "object",
"properties": {
"auditLogConfigs": {
"items": {
"$ref": "AuditLogConfig"
},
"type": "array",
"description": "The configuration for logging of each type of permission."
},
"service": {
"type": "string",
"description": "Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services."
}
}
},
"ListCertificateRevocationListsResponse": {
"description": "Response message for CertificateAuthorityService.ListCertificateRevocationLists.",
"properties": {
"certificateRevocationLists": {
"type": "array",
"items": {
"$ref": "CertificateRevocationList"
},
"description": "The list of CertificateRevocationLists."
},
"nextPageToken": {
"description": "A token to retrieve next page of results. Pass this value in ListCertificateRevocationListsRequest.next_page_token to retrieve the next page of results.",
"type": "string"
},
"unreachable": {
"items": {
"type": "string"
},
"type": "array",
"description": "A list of locations (e.g. \"us-west1\") that could not be reached."
}
},
"id": "ListCertificateRevocationListsResponse",
"type": "object"
},
"OperationMetadata": {
"properties": {
"apiVersion": {
"description": "Output only. API version used to start the operation.",
"readOnly": true,
"type": "string"
},
"verb": {
"description": "Output only. Name of the verb executed by the operation.",
"readOnly": true,
"type": "string"
},
"target": {
"readOnly": true,
"description": "Output only. Server-defined resource path for the target of the operation.",
"type": "string"
},
"requestedCancellation": {
"description": "Output only. Identifies whether the user has requested cancellation of the operation. Operations that have successfully been cancelled have Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.",
"readOnly": true,
"type": "boolean"
},
"createTime": {
"readOnly": true,
"type": "string",
"description": "Output only. The time the operation was created.",
"format": "google-datetime"
},
"statusMessage": {
"readOnly": true,
"description": "Output only. Human-readable status of the operation, if any.",
"type": "string"
},
"endTime": {
"type": "string",
"readOnly": true,
"format": "google-datetime",
"description": "Output only. The time the operation finished running."
}
},
"type": "object",
"id": "OperationMetadata",
"description": "Represents the metadata of the long-running operation."
},
"ListCertificatesResponse": {
"id": "ListCertificatesResponse",
"type": "object",
"properties": {
"certificates": {
"description": "The list of Certificates.",
"items": {
"$ref": "Certificate"
},
"type": "array"
},
"unreachable": {
"type": "array",
"items": {
"type": "string"
},
"description": "A list of locations (e.g. \"us-west1\") that could not be reached."
},
"nextPageToken": {
"description": "A token to retrieve next page of results. Pass this value in ListCertificatesRequest.next_page_token to retrieve the next page of results.",
"type": "string"
}
},
"description": "Response message for CertificateAuthorityService.ListCertificates."
},
"RestoreCertificateAuthorityRequest": {
"type": "object",
"description": "Request message for CertificateAuthorityService.RestoreCertificateAuthority.",
"id": "RestoreCertificateAuthorityRequest",
"properties": {
"requestId": {
"description": "Optional. An ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and t he request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).",
"type": "string"
}
}
},
"RevocationDetails": {
"description": "Describes fields that are relavent to the revocation of a Certificate.",
"properties": {
"revocationState": {
"enum": [
"REVOCATION_REASON_UNSPECIFIED",
"KEY_COMPROMISE",
"CERTIFICATE_AUTHORITY_COMPROMISE",
"AFFILIATION_CHANGED",
"SUPERSEDED",
"CESSATION_OF_OPERATION",
"CERTIFICATE_HOLD",
"PRIVILEGE_WITHDRAWN",
"ATTRIBUTE_AUTHORITY_COMPROMISE"
],
"enumDescriptions": [
"Default unspecified value. This value does indicate that a Certificate has been revoked, but that a reason has not been recorded.",
"Key material for this Certificate may have leaked.",
"The key material for a certificate authority in the issuing path may have leaked.",
"The subject or other attributes in this Certificate have changed.",
"This Certificate has been superseded.",
"This Certificate or entities in the issuing path have ceased to operate.",
"This Certificate should not be considered valid, it is expected that it may become valid in the future.",
"This Certificate no longer has permission to assert the listed attributes.",
"The authority which determines appropriate attributes for a Certificate may have been compromised."
],
"type": "string",
"description": "Indicates why a Certificate was revoked."
},
"revocationTime": {
"type": "string",
"description": "The time at which this Certificate was revoked.",
"format": "google-datetime"
}
},
"type": "object",
"id": "RevocationDetails"
},
"SubordinateConfig": {
"description": "Describes a subordinate CA's issuers. This is either a resource path to a known issuing CertificateAuthority, or a PEM issuer certificate chain.",
"properties": {
"pemIssuerChain": {
"description": "Required. Contains the PEM certificate chain for the issuers of this CertificateAuthority, but not pem certificate for this CA itself.",
"$ref": "SubordinateConfigChain"
},
"certificateAuthority": {
"type": "string",
"description": "Required. This can refer to a CertificateAuthority in the same project that was used to create a subordinate CertificateAuthority. This field is used for information and usability purposes only. The resource name is in the format `projects/*/locations/*/certificateAuthorities/*`."
}
},
"type": "object",
"id": "SubordinateConfig"
},
"SubjectAltNames": {
"id": "SubjectAltNames",
"type": "object",
"properties": {
"customSans": {
"type": "array",
"items": {
"$ref": "X509Extension"
},
"description": "Contains additional subject alternative name values."
},
"dnsNames": {
"items": {
"type": "string"
},
"type": "array",
"description": "Contains only valid, fully-qualified host names."
},
"emailAddresses": {
"description": "Contains only valid RFC 2822 E-mail addresses.",
"type": "array",
"items": {
"type": "string"
}
},
"ipAddresses": {
"description": "Contains only valid 32-bit IPv4 addresses or RFC 4291 IPv6 addresses.",
"items": {
"type": "string"
},
"type": "array"
},
"uris": {
"items": {
"type": "string"
},
"description": "Contains only valid RFC 3986 URIs.",
"type": "array"
}
},
"description": "SubjectAltNames corresponds to a more modern way of listing what the asserted identity is in a certificate (i.e., compared to the \"common name\" in the distinguished name)."
},
"Policy": {
"id": "Policy",
"type": "object",
"description": "An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members` to a single `role`. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** { \"bindings\": [ { \"role\": \"roles/resourcemanager.organizationAdmin\", \"members\": [ \"user:[email protected]\", \"group:[email protected]\", \"domain:google.com\", \"serviceAccount:[email protected]\" ] }, { \"role\": \"roles/resourcemanager.organizationViewer\", \"members\": [ \"user:[email protected]\" ], \"condition\": { \"title\": \"expirable access\", \"description\": \"Does not grant access after Sep 2020\", \"expression\": \"request.time \u003c timestamp('2020-10-01T00:00:00.000Z')\", } } ], \"etag\": \"BwWWja0YfJA=\", \"version\": 3 } **YAML example:** bindings: - members: - user:[email protected] - group:[email protected] - domain:google.com - serviceAccount:[email protected] role: roles/resourcemanager.organizationAdmin - members: - user:[email protected] role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time \u003c timestamp('2020-10-01T00:00:00.000Z') - etag: BwWWja0YfJA= - version: 3 For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/).",
"properties": {
"auditConfigs": {
"items": {
"$ref": "AuditConfig"
},
"type": "array",
"description": "Specifies cloud audit logging configuration for this policy."
},
"etag": {
"format": "byte",
"description": "`etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost.",
"type": "string"
},
"bindings": {
"items": {
"$ref": "Binding"
},
"type": "array",
"description": "Associates a list of `members` to a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one member."
},
"version": {
"format": "int32",
"type": "integer",
"description": "Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies)."
}
}
},
"ReusableConfigWrapper": {
"type": "object",
"id": "ReusableConfigWrapper",
"description": "A ReusableConfigWrapper describes values that may assist in creating an X.509 certificate, or a reference to a pre-defined set of values.",
"properties": {
"reusableConfig": {
"type": "string",
"description": "Required. A resource path to a ReusableConfig in the format `projects/*/locations/*/reusableConfigs/*`."
},
"reusableConfigValues": {
"description": "Required. A user-specified inline ReusableConfigValues.",
"$ref": "ReusableConfigValues"
}
}
},
"X509Extension": {
"type": "object",
"id": "X509Extension",
"description": "An X509Extension specifies an X.509 extension, which may be used in different parts of X.509 objects like certificates, CSRs, and CRLs.",
"properties": {
"critical": {
"description": "Required. Indicates whether or not this extension is critical (i.e., if the client does not know how to handle this extension, the client should consider this to be an error).",
"type": "boolean"
},
"value": {
"description": "Required. The value of this X.509 extension.",
"type": "string",
"format": "byte"
},
"objectId": {
"description": "Required. The OID for this X.509 extension.",
"$ref": "ObjectId"
}
}
},
"PublicKey": {
"description": "A PublicKey describes a public key.",
"id": "PublicKey",
"properties": {
"key": {
"type": "string",
"description": "Required. A public key. When this is specified in a request, the padding and encoding can be any of the options described by the respective 'KeyType' value. When this is generated by the service, it will always be an RFC 5280 [SubjectPublicKeyInfo](https://tools.ietf.org/html/rfc5280#section-4.1) structure containing an algorithm identifier and a key.",
"format": "byte"
},
"type": {
"description": "Required. The type of public key.",
"enum": [
"KEY_TYPE_UNSPECIFIED",
"PEM_RSA_KEY",
"PEM_EC_KEY"
],
"type": "string",
"enumDescriptions": [
"Default unspecified value.",
"A PEM-encoded PKCS#1/RFC 3447 RSAPrivateKey structure, or an RFC 5280 [SubjectPublicKeyInfo](https://tools.ietf.org/html/rfc5280#section-4.1) structure containing the former.",
"A PEM-encoded compressed NIST P-256/secp256r1/prime256v1 or P-384 key, or an RFC 5280 [SubjectPublicKeyInfo](https://tools.ietf.org/html/rfc5280#section-4.1) structure containing the former."
]
}
},
"type": "object"
},
"Status": {
"id": "Status",
"properties": {
"code": {
"format": "int32",
"type": "integer",
"description": "The status code, which should be an enum value of google.rpc.Code."
},
"details": {
"description": "A list of messages that carry the error details. There is a common set of message types for APIs to use.",
"type": "array",
"items": {
"type": "object",
"additionalProperties": {
"type": "any",
"description": "Properties of the object. Contains field @type with type URL."
}
}
},
"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."
}
},
"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"
},
"EnableCertificateAuthorityRequest": {
"type": "object",
"description": "Request message for CertificateAuthorityService.EnableCertificateAuthority.",
"id": "EnableCertificateAuthorityRequest",
"properties": {
"requestId": {
"type": "string",
"description": "Optional. An ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and t he request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000)."
}
}
},
"Operation": {
"description": "This resource represents a long-running operation that is the result of a network API call.",
"id": "Operation",
"type": "object",
"properties": {
"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": {
"additionalProperties": {
"type": "any",
"description": "Properties of the object. Contains field @type with type URL."
},
"type": "object",
"description": "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`."
},
"metadata": {
"additionalProperties": {
"type": "any",
"description": "Properties of the object. Contains field @type with type URL."
},
"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.",
"type": "object"
}
}
},
"Subject": {
"description": "Subject describes parts of a distinguished name that, in turn, describes the subject of the certificate.",
"id": "Subject",
"type": "object",
"properties": {
"organization": {
"description": "The organization of the subject.",
"type": "string"
},
"locality": {
"type": "string",
"description": "The locality or city of the subject."
},
"postalCode": {
"type": "string",
"description": "The postal code of the subject."
},
"province": {
"description": "The province, territory, or regional state of the subject.",
"type": "string"
},
"streetAddress": {
"type": "string",
"description": "The street address of the subject."
},
"countryCode": {
"description": "The country code of the subject.",
"type": "string"
},
"organizationalUnit": {
"type": "string",
"description": "The organizational_unit of the subject."
}
}
},
"DisableCertificateAuthorityRequest": {
"description": "Request message for CertificateAuthorityService.DisableCertificateAuthority.",
"id": "DisableCertificateAuthorityRequest",
"type": "object",
"properties": {
"requestId": {
"type": "string",
"description": "Optional. An ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and t he request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000)."
}
}
},
"ListOperationsResponse": {
"description": "The response message for Operations.ListOperations.",
"id": "ListOperationsResponse",
"type": "object",
"properties": {
"operations": {
"items": {
"$ref": "Operation"
},
"type": "array",
"description": "A list of operations that matches the specified filter in the request."
},
"nextPageToken": {
"type": "string",
"description": "The standard List next-page token."
}
}
},
"AllowedSubjectAltNames": {
"properties": {
"allowedUris": {
"description": "Optional. Contains valid RFC 3986 URIs. Glob patterns are also supported. To match across path seperators (i.e. '/') use the double star glob pattern (i.e. '**').",
"items": {
"type": "string"
},
"type": "array"
},
"allowedIps": {
"description": "Optional. Contains valid 32-bit IPv4 addresses and subnet ranges or RFC 4291 IPv6 addresses and subnet ranges. Subnet ranges are specified using the '/' notation (e.g. 10.0.0.0/8, 2001:700:300:1800::/64). Glob patterns are supported only for ip address entries (i.e. not for subnet ranges).",
"type": "array",
"items": {
"type": "string"
}
},
"allowedEmailAddresses": {
"items": {
"type": "string"
},
"type": "array",
"description": "Optional. Contains valid RFC 2822 E-mail addresses. Glob patterns are also supported."
},
"allowGlobbingDnsWildcards": {
"description": "Optional. Specifies if glob patterns used for allowed_dns_names allow wildcard certificates. If this is set, certificate requests with wildcard domains will be permitted to match a glob pattern specified in allowed_dns_names. Otherwise, certificate requests with wildcard domains will be permitted only if allowed_dns_names contains a literal wildcard.",
"type": "boolean"
},
"allowedDnsNames": {
"items": {
"type": "string"
},
"type": "array",
"description": "Optional. Contains valid, fully-qualified host names. Glob patterns are also supported. To allow an explicit wildcard certificate, escape with backlash (i.e. \"\\*\"). E.g. for globbed entries: '*bar.com' will allow 'foo.bar.com', but not '*.bar.com', unless the allow_globbing_dns_wildcards field is set. E.g. for wildcard entries: '\\*.bar.com' will allow '*.bar.com', but not 'foo.bar.com'."
},
"allowCustomSans": {
"type": "boolean",
"description": "Optional. Specifies if to allow custom X509Extension values."
}
},
"type": "object",
"description": "AllowedSubjectAltNames specifies the allowed values for SubjectAltNames by the CertificateAuthority when issuing Certificates.",
"id": "AllowedSubjectAltNames"
},
"SetIamPolicyRequest": {
"properties": {
"updateMask": {
"format": "google-fieldmask",
"type": "string",
"description": "OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only the fields in the mask will be modified. If no mask is provided, the following default mask is used: `paths: \"bindings, etag\"`"
},
"policy": {
"$ref": "Policy",
"description": "REQUIRED: The complete policy to be applied to the `resource`. The size of the policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Cloud Platform services (such as Projects) might reject them."
}
},
"description": "Request message for `SetIamPolicy` method.",
"id": "SetIamPolicyRequest",
"type": "object"
},
"AccessUrls": {
"type": "object",
"id": "AccessUrls",
"properties": {
"crlAccessUrl": {
"description": "The URL where this CertificateAuthority's CRLs are published. This will only be set for CAs that have been activated.",
"type": "string"
},
"caCertificateAccessUrl": {
"type": "string",
"description": "The URL where this CertificateAuthority's CA certificate is published. This will only be set for CAs that have been activated."
}
},
"description": "URLs where a CertificateAuthority will publish content."
},
"CertificateDescription": {
"description": "A CertificateDescription describes an X.509 certificate or CSR that has been issued, as an alternative to using ASN.1 / X.509.",
"type": "object",
"properties": {
"subjectDescription": {
"$ref": "SubjectDescription",
"description": "Describes some of the values in a certificate that are related to the subject and lifetime."
},
"configValues": {
"description": "Describes some of the technical fields in a certificate.",
"$ref": "ReusableConfigValues"
},
"publicKey": {
"description": "The public key that corresponds to an issued certificate.",
"$ref": "PublicKey"
},
"subjectKeyId": {
"$ref": "KeyId",
"description": "Provides a means of identifiying certificates that contain a particular public key, per https://tools.ietf.org/html/rfc5280#section-4.2.1.2."
},
"crlDistributionPoints": {
"description": "Describes a list of locations to obtain CRL information, i.e. the DistributionPoint.fullName described by https://tools.ietf.org/html/rfc5280#section-4.2.1.13",
"items": {
"type": "string"
},
"type": "array"
},
"authorityKeyId": {
"$ref": "KeyId",
"description": "Identifies the subject_key_id of the parent certificate, per https://tools.ietf.org/html/rfc5280#section-4.2.1.1"
},
"certFingerprint": {
"description": "The hash of the x.509 certificate.",
"$ref": "CertificateFingerprint"
},
"aiaIssuingCertificateUrls": {
"items": {
"type": "string"
},
"description": "Describes lists of issuer CA certificate URLs that appear in the \"Authority Information Access\" extension in the certificate.",
"type": "array"
}
},
"id": "CertificateDescription"
},
"ScheduleDeleteCertificateAuthorityRequest": {
"properties": {
"requestId": {
"type": "string",
"description": "Optional. An ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and t he request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000)."
}
},
"type": "object",
"description": "Request message for CertificateAuthorityService.ScheduleDeleteCertificateAuthority.",
"id": "ScheduleDeleteCertificateAuthorityRequest"
},
"Location": {
"id": "Location",
"properties": {
"displayName": {
"type": "string",
"description": "The friendly name for this location, typically a nearby city name. For example, \"Tokyo\"."
},
"labels": {
"description": "Cross-service attributes for the location. For example {\"cloud.googleapis.com/region\": \"us-east1\"}",
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"name": {
"description": "Resource name for the location, which may vary between implementations. For example: `\"projects/example-project/locations/us-east1\"`",
"type": "string"
},
"metadata": {
"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."
},
"type": "object"
},
"locationId": {
"type": "string",
"description": "The canonical id for this location. For example: `\"us-east1\"`."
}
},
"type": "object",
"description": "A resource that represents Google Cloud Platform location."
},
"Empty": {
"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); } The JSON representation for `Empty` is empty JSON object `{}`.",
"type": "object",
"properties": {},
"id": "Empty"
},
"TestIamPermissionsRequest": {
"type": "object",
"properties": {
"permissions": {
"type": "array",
"description": "The set of permissions to check for the `resource`. Permissions with wildcards (such as '*' or 'storage.*') are not allowed. For more information see [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).",
"items": {
"type": "string"
}
}
},
"id": "TestIamPermissionsRequest",
"description": "Request message for `TestIamPermissions` method."
},
"SubordinateConfigChain": {
"id": "SubordinateConfigChain",
"description": "This message describes a subordinate CA's issuer certificate chain. This wrapper exists for compatibility reasons.",
"properties": {
"pemCertificates": {
"description": "Required. Expected to be in leaf-to-root order according to RFC 5246.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"KeyId": {
"id": "KeyId",
"properties": {
"keyId": {
"description": "Optional. The value of this KeyId encoded in lowercase hexadecimal. This is most likely the 160 bit SHA-1 hash of the public key.",
"type": "string"
}
},
"type": "object",
"description": "A KeyId identifies a specific public key, usually by hashing the public key."
},
"AllowedConfigList": {
"id": "AllowedConfigList",
"type": "object",
"properties": {
"allowedConfigValues": {
"items": {
"$ref": "ReusableConfigWrapper"
},
"type": "array",
"description": "Required. All Certificates issued by the CertificateAuthority must match at least one listed ReusableConfigWrapper. If a ReusableConfigWrapper has an empty field, any value will be allowed for that field."
}
}
},
"AuditLogConfig": {
"properties": {
"logType": {
"type": "string",
"description": "The log type that this config enables.",
"enumDescriptions": [
"Default case. Should never be this.",
"Admin reads. Example: CloudIAM getIamPolicy",
"Data writes. Example: CloudSQL Users create",
"Data reads. Example: CloudSQL Users list"
],
"enum": [
"LOG_TYPE_UNSPECIFIED",
"ADMIN_READ",
"DATA_WRITE",
"DATA_READ"
]
},
"exemptedMembers": {
"description": "Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members.",
"items": {
"type": "string"
},
"type": "array"
}
},
"id": "AuditLogConfig",
"type": "object",
"description": "Provides the configuration for logging a type of permissions. Example: { \"audit_log_configs\": [ { \"log_type\": \"DATA_READ\", \"exempted_members\": [ \"user:[email protected]\" ] }, { \"log_type\": \"DATA_WRITE\" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting [email protected] from DATA_READ logging."
}
},
"description": "The Certificate Authority Service API is a highly-available, scalable service that enables you to simplify and automate the management of private certificate authorities (CAs) while staying in control of your private keys.\" ",
"discoveryVersion": "v1"
}