REST Resource: accounts.clients.users

Resource: ClientUser

A client user is created under a client buyer and has restricted access to the Ad Exchange Marketplace and certain other sections of the Ad Exchange Buyer UI based on the role granted to the associated client buyer.

The only way a new client user can be created is via accepting an email invitation (see the accounts.clients.invitations.create method).

All fields are required unless otherwise specified.

JSON representation
{
  "userId": string,
  "clientAccountId": string,
  "status": enum(UserStatus),
  "email": string,
}
Fields
userId

string (int64 format)

The unique numerical ID of the client user that has accepted an invitation. The value of this field is ignored in an update operation.

clientAccountId

string (int64 format)

Numerical account ID of the client buyer with which the user is associated; the buyer must be a client of the current sponsor buyer. The value of this field is ignored in an update operation.

status

enum(UserStatus)

The status of the client user.

email

string

User's email address. The value of this field is ignored in an update operation.

UserStatus

Valid user status.

Enums
USER_STATUS_UNSPECIFIED A placeholder for an undefined user status.
PENDING A user who was already created but hasn't accepted the invitation yet.
ACTIVE A user that is currently active.
DISABLED A user that is currently disabled.

Methods

get

Retrieves an existing client user.

list

Lists all the known client users for a specified sponsor buyer account ID.

update

Updates an existing client user.

Send feedback about...

Buyer REST API
Buyer REST API