REST Resource: buyers.clients.users

  • A ClientUser is a user with restricted access to the Marketplace and Authorized Buyers UI based on their role.

  • ClientUsers have states: INVITED, ACTIVE, or INACTIVE, determining UI access.

  • You can manage ClientUsers through methods like create, activate, deactivate, and delete.

  • ClientUser information includes name, state, and a unique email address.

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

Valid user 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

activate

 Activates an existing client user.

create

 Creates a new client user in "INVITED" state.

deactivate

 Deactivates an existing client user.

delete

 Deletes an existing client user.

get

 Retrieves an existing client user.

list

 Lists all client users for a specified client.