Method: buyers.clients.users.deactivate
Stay organized with collections
Save and categorize content based on your preferences.
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
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-09-18 UTC.
[null,null,["Last updated 2024-09-18 UTC."],[],["This document outlines how to deactivate a client user via a `POST` HTTP request to a specified URL. The required `name` path parameter identifies the user. The request body must be empty. Upon success, the client user's state changes from \"ACTIVE\" to \"INACTIVE,\" returning a `ClientUser` instance. The action has no effect if the user is already \"INACTIVE,\" and fails if the user is \"INVITED.\" Authorization requires the `https://www.googleapis.com/auth/authorized-buyers-marketplace` scope.\n"],null,[]]