Method: projects.locations.instances.transactionPolicies.disable

Starts disabling a policy, or withdraws a policy that is still waiting for activation.

For an active policy, the policy stays in effect while the disable request collects the required number of Policy Author approvals through transactionPolicies.approve. Once enough approvals are recorded, the policy is disabled.

For a policy that has not yet been activated, no further approvals are needed. The policy is disabled immediately, and deactivationInfo.transition_sequence is left unset, so the policy set version does not change because the policy was never in effect. Disabled policies are kept for auditing.

Returns the following error codes:

  • NOT_FOUND: The TransactionPolicy does not exist.
  • FAILED_PRECONDITION: The policy is already disabled or already has a pending disable request.
  • INVALID_ARGUMENT: The authorization in authorizationInfo cannot be verified.
  • PERMISSION_DENIED: The caller is not an authorized Policy Author.

HTTP request

POST https://mpc.googleapis.com/v1beta/{name=projects/*/locations/*/instances/*/transactionPolicies/*}:disable

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
name

string

Required. The name of the TransactionPolicy to disable or withdraw. Format: projects/{project}/locations/{location}/instances/{instance}/transactionPolicies/{transactionPolicy} It takes the form projects/{project}/locations/{location}/instances/{instance}/transactionPolicies/{transactionpolicies}.

Request body

The request body contains data with the following structure:

JSON representation 
{
  "authorizationInfo": {
    object (AuthorizationInfo)
  }
}
Fields
authorizationInfo

object (AuthorizationInfo)

Required. The Policy Author's authorization over a TransactionPolicySigningPayload with:

  • transactionPolicy: set to name
  • action: DISABLE
  • rule: set to the policy's rule

For an active policy, this authorization is recorded as the first entry in deactivationInfo.approvals. For a policy that is still waiting for activation, this single authorization is recorded in deactivationInfo.approvals and withdraws the policy immediately.

Response body

If successful, the response body contains an instance of TransactionPolicy.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.