Method: projects.locations.caPools.certificateAuthorities.disable
Stay organized with collections
Save and categorize content based on your preferences.
HTTP request
POST https://privateca.googleapis.com/v1/{name=projects/*/locations/*/caPools/*/certificateAuthorities/*}:disable
The URL uses gRPC Transcoding syntax.
Path parameters
| Parameters |
name |
string
Required. The resource name for this CertificateAuthority in the format projects/*/locations/*/caPools/*/certificateAuthorities/*.
Authorization requires the following IAM permission on the specified resource name:
privateca.certificateAuthorities.update
|
Request body
The request body contains data with the following structure:
| JSON representation |
{
"requestId": string,
"ignoreDependentResources": boolean
} |
| Fields |
requestId |
string
Optional. An ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the 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).
|
ignoreDependentResources |
boolean
Optional. This field allows this CA to be disabled even if it's being depended on by another resource. However, doing so may result in unintended and unrecoverable effects on any dependent resources since the CA will no longer be able to issue certificates.
|
Response body
If successful, the response body contains an instance of Operation.
Authorization scopes
Requires the following OAuth scope:
https://www.googleapis.com/auth/cloud-platform
For more information, see the Authentication Overview.
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-05-30 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-05-30 UTC."],[[["\u003cp\u003eThis document describes how to disable a CertificateAuthority via a POST HTTP request to a specified URL, adhering to gRPC Transcoding syntax.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003ename\u003c/code\u003e path parameter is required, specifying the resource name of the CertificateAuthority, and authorization requires the \u003ccode\u003eprivateca.certificateAuthorities.update\u003c/code\u003e IAM permission.\u003c/p\u003e\n"],["\u003cp\u003eThe request body can contain an optional \u003ccode\u003erequestId\u003c/code\u003e string for idempotency, and an \u003ccode\u003eignoreDependentResources\u003c/code\u003e boolean to enable disabling even if the resource is depended upon.\u003c/p\u003e\n"],["\u003cp\u003eA successful request returns an \u003ccode\u003eOperation\u003c/code\u003e instance in the response body, indicating the status of the disable operation.\u003c/p\u003e\n"],["\u003cp\u003eThe request needs the \u003ccode\u003ehttps://www.googleapis.com/auth/cloud-platform\u003c/code\u003e authorization scope.\u003c/p\u003e\n"]]],[],null,["# Method: projects.locations.caPools.certificateAuthorities.disable\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Path parameters](#body.PATH_PARAMETERS)\n- [Request body](#body.request_body)\n - [JSON representation](#body.request_body.SCHEMA_REPRESENTATION)\n- [Response body](#body.response_body)\n- [Authorization scopes](#body.aspect)\n\nDisable a [CertificateAuthority](/certificate-authority-service/docs/reference/rest/v1/projects.locations.caPools.certificateAuthorities#CertificateAuthority).\n\n### HTTP request\n\n`POST https://privateca.googleapis.com/v1/{name=projects/*/locations/*/caPools/*/certificateAuthorities/*}:disable`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n### Request body\n\nThe request body contains data with the following structure:\n\n### Response body\n\nIf successful, the response body contains an instance of [Operation](/certificate-authority-service/docs/reference/rest/v1/projects.locations.operations#Operation).\n\n### Authorization scopes\n\nRequires the following OAuth scope:\n\n- `https://www.googleapis.com/auth/cloud-platform`\n\nFor more information, see the [Authentication Overview](/docs/authentication#authorization-gcp)."]]
