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/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
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."],[[["\u003cp\u003eDeactivates an existing client user, changing their state from "ACTIVE" to "INACTIVE".\u003c/p\u003e\n"],["\u003cp\u003eRequires the client user to be in "ACTIVE" state; returns an error if in "INVITED" state and has no effect if already "INACTIVE".\u003c/p\u003e\n"],["\u003cp\u003eUses an HTTP POST request to the specified URL with the client user's information in the path parameters.\u003c/p\u003e\n"],["\u003cp\u003eRequest body should be empty, and a successful response returns the ClientUser object.\u003c/p\u003e\n"],["\u003cp\u003eRequires authorization with the \u003ccode\u003ehttps://www.googleapis.com/auth/authorized-buyers-marketplace\u003c/code\u003e scope.\u003c/p\u003e\n"]]],["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 user's state changes from \"ACTIVE\" to \"INACTIVE\", and the response body returns a `ClientUser` instance. The method does nothing if the user is already inactive and errors if the user is \"INVITED\". Authorization requires the `authorized-buyers-marketplace` OAuth scope.\n"],null,["# Method: buyers.clients.users.deactivate\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Path parameters](#body.PATH_PARAMETERS)\n- [Request body](#body.request_body)\n- [Response body](#body.response_body)\n- [Authorization scopes](#body.aspect)\n- [Try it!](#try-it)\n\nDeactivates 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.\n\n### HTTP request\n\n`POST https://authorizedbuyersmarketplace.googleapis.com/v1/{name=buyers/*/clients/*/users/*}:deactivate`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|--------|-----------------------------------------------------------------------------------------------------|\n| `name` | `string` Required. Format: `buyers/{buyerAccountId}/clients/{clientAccountId}/clientUsers/{userId}` |\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\nIf successful, the response body contains an instance of [ClientUser](/authorized-buyers/apis/marketplace/reference/rest/v1/buyers.clients.users#ClientUser).\n\n### Authorization scopes\n\nRequires the following OAuth scope:\n\n- `https://www.googleapis.com/auth/authorized-buyers-marketplace`"]]
