Method: buyers.clients.users.deactivate

  • This document outlines how to deactivate an existing client user via an HTTP POST request.

  • Deactivating a client user changes their state from "ACTIVE" to "INACTIVE".

  • The HTTP request requires a name path parameter specifying the buyer, client, and user IDs.

  • The request body should be empty, and a successful response will contain a ClientUser instance.

  • The https://www.googleapis.com/auth/authorized-buyers-marketplace OAuth scope is required for authorization.

Deactivates an existing client user. The state of the client user will be updated from "ACTIVE" to "INACTIVE". This method has no effect if the client user is already in "INACTIVE" state. An error will be returned if the client user to deactivate is still in "INVITED" state.

HTTP request

POST https://authorizedbuyersmarketplace.googleapis.com/v1alpha/{name=buyers/*/clients/*/users/*}:deactivate

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
name

string

Required. Format: buyers/{buyerAccountId}/clients/{clientAccountId}/clientUsers/{userId}

Request body

The request body must be empty.

Response body

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

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/authorized-buyers-marketplace