Method: buyers.clients.users.deactivate

  • Deactivates an existing client user, changing their state from "ACTIVE" to "INACTIVE".

  • Requires the client user to be in "ACTIVE" state; returns an error if in "INVITED" state and has no effect if already "INACTIVE".

  • Uses an HTTP POST request to the specified URL with the client user's information in the path parameters.

  • The request body should be empty, and a successful response returns the ClientUser object.

  • Needs authorization with the https://www.googleapis.com/auth/authorized-buyers-marketplace scope.

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