Method: buyers.clients.users.deactivate

  • The deactivate method changes a client user's state from "ACTIVE" to "INACTIVE" and has no effect if the user is already inactive, but will return an error if the user is in an "INVITED" state.

  • The HTTP request uses a POST method to a specific URL including the buyer account ID, client account ID, and user ID.

  • This method requires an empty request body and returns a ClientUser instance in the response body upon success.

  • The deactivate method requires the https://www.googleapis.com/auth/authorized-buyers-marketplace OAuth scope 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/v1/{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