Method: projects.locations.instances.users.disable

Disables a User and all of their roles at once. A disabled User cannot use any role. To disable one role, use users.disableRole.

Each role is disabled as by users.disableRole, and one authorizationInfo covers every ADMIN and POLICY_AUTHOR role change. Every role is checked before any is changed, so the request either applies to all roles or fails without changing anything. Once it is accepted, SIGNER is disabled immediately while ADMIN and POLICY_AUTHOR wait for approval. The User's state becomes DISABLED when all of their roles are disabled.

Fails with FAILED_PRECONDITION while the User holds key shares, until resharing is supported, or if it would leave too few active Admins.

HTTP request

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

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
name

string

Required. The name of the User to disable. Format: projects/{project}/locations/{location}/instances/{instance}/users/{user} It takes the form projects/{project}/locations/{location}/instances/{instance}/users/{user}.

Request body

The request body contains data with the following structure:

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

object (AuthorizationInfo)

Optional. The calling Admin's signature over a UserSigningPayload with a DISABLE role change for each of the User's ACTIVE or PENDING_DISABLED ADMIN and POLICY_AUTHOR roles, plus any other pending changes. Required if the User has either; must be empty otherwise.

Response body

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

Authorization scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview.