REST Resource: buyers.clients.users
Resource: ClientUser
A user of a client who has restricted access to the Marketplace and certain other sections of the Authorized Buyers UI based on the role granted to the associated client.
JSON representation |
{
"name": string,
"state": enum (State ),
"email": string
} |
Fields |
name |
string
Output only. The resource name of the client user. Format: buyers/{accountId}/clients/{clientAccountId}/users/{userId}
|
state |
enum (State )
Output only. The state of the client user.
|
email |
string
Required. The client user's email address that has to be unique across all users for the same client.
|
State
Enums |
STATE_UNSPECIFIED |
A placeholder for an undefined user state. |
INVITED |
A user who was created but hasn't accepted the invitation yet, not allowed to access the Authorized Buyers UI. |
ACTIVE |
A user that is currently active and allowed to access the Authorized Buyers UI. |
INACTIVE |
A user that is currently inactive and not allowed to access the Authorized Buyers UI. |
Methods |
|
Activates an existing client user. |
|
Creates a new client user in "INVITED" state. |
|
Deactivates an existing client user. |
|
Deletes an existing client user. |
|
Retrieves an existing client user. |
|
Lists all client users for a specified client. |
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."],[[["ClientUser resources represent users with restricted access to the Marketplace and Authorized Buyers UI based on their assigned role."],["These users have a defined state (invited, active, inactive) which dictates their access permissions."],["You can manage ClientUsers by activating, deactivating, creating, deleting, retrieving, and listing them using the provided methods."],["ClientUser data is structured with `name`, `state`, and `email` fields, and represented in JSON format."]]],["Client users, who have limited access to the Authorized Buyers UI, are defined by their `name`, `state`, and `email`. The `state` can be `INVITED`, `ACTIVE`, or `INACTIVE`. Methods available include `create`, to add a user in an \"INVITED\" state, `activate`, `deactivate`, and `delete` to manage user states. Additionally, there are `get` and `list` methods to retrieve user details, and all users must have a unique email address.\n"]]