Authorized Buyers Marketplace API . buyers . clients . users

activate(name, body=None, x__xgafv=None)

Activates an existing client user. The state of the client user will be updated from "INACTIVE" to "ACTIVE". This method has no effect if the client user is already in "ACTIVE" state. An error will be returned if the client user to activate is still in "INVITED" state.

Args:
  name: string, Required. Format: `buyers/{buyerAccountId}/clients/{clientAccountId}/clientUsers/{userId}` (required)
  body: object, The request body.
    The object takes the form of:

{ # Request message for activating a client user.
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # 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.
  "email": "A String", # Required. The client user's email address that has to be unique across all users for the same client.
  "name": "A String", # Output only. The resource name of the client user. Format: `buyers/{accountId}/clients/{clientAccountId}/users/{userId}`
  "state": "A String", # Output only. The state of the client user.
}

close()

Close httplib2 connections.

create(parent, body=None, x__xgafv=None)

Creates a new client user in "INVITED" state. An email invitation will be sent to the new user, once accepted the user will become active.

Args:
  parent: string, Required. The name of the client. Format: `buyers/{accountId}/clients/{clientAccountId}` (required)
  body: object, The request body.
    The object takes the form of:

{ # 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.
  "email": "A String", # Required. The client user's email address that has to be unique across all users for the same client.
  "name": "A String", # Output only. The resource name of the client user. Format: `buyers/{accountId}/clients/{clientAccountId}/users/{userId}`
  "state": "A String", # Output only. The state of the client user.
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # 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.
  "email": "A String", # Required. The client user's email address that has to be unique across all users for the same client.
  "name": "A String", # Output only. The resource name of the client user. Format: `buyers/{accountId}/clients/{clientAccountId}/users/{userId}`
  "state": "A String", # Output only. The state of the client user.
}

deactivate(name, body=None, x__xgafv=None)

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.

Args:
  name: string, Required. Format: `buyers/{buyerAccountId}/clients/{clientAccountId}/clientUsers/{userId}` (required)
  body: object, The request body.
    The object takes the form of:

{ # Request message for deactivating a client user.
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # 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.
  "email": "A String", # Required. The client user's email address that has to be unique across all users for the same client.
  "name": "A String", # Output only. The resource name of the client user. Format: `buyers/{accountId}/clients/{clientAccountId}/users/{userId}`
  "state": "A String", # Output only. The state of the client user.
}

delete(name, x__xgafv=None)

Deletes an existing client user. The client user will lose access to the Authorized Buyers UI. Note that if a client user is deleted, the user's access to the UI can't be restored unless a new client user is created and activated.

Args:
  name: string, Required. Format: `buyers/{buyerAccountId}/clients/{clientAccountId}/clientUsers/{userId}` (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
}

get(name, x__xgafv=None)

Retrieves an existing client user.

Args:
  name: string, Required. Format: `buyers/{buyerAccountId}/clients/{clientAccountId}/clientUsers/{userId}` (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # 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.
  "email": "A String", # Required. The client user's email address that has to be unique across all users for the same client.
  "name": "A String", # Output only. The resource name of the client user. Format: `buyers/{accountId}/clients/{clientAccountId}/users/{userId}`
  "state": "A String", # Output only. The state of the client user.
}

list(parent, pageSize=None, pageToken=None, x__xgafv=None)

Lists all client users for a specified client.

Args:
  parent: string, Required. The name of the client. Format: `buyers/{buyerAccountId}/clients/{clientAccountId}` (required)
  pageSize: integer, Requested page size. If left blank, a default page size of 500 will be applied.
  pageToken: string, A token identifying a page of results the server should return. Typically, this is the value of ListClientUsersResponse.nextPageToken returned from the previous call to the list method.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Response message for the list method.
  "clientUsers": [ # The returned list of client users.
    { # 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.
      "email": "A String", # Required. The client user's email address that has to be unique across all users for the same client.
      "name": "A String", # Output only. The resource name of the client user. Format: `buyers/{accountId}/clients/{clientAccountId}/users/{userId}`
      "state": "A String", # Output only. The state of the client user.
    },
  ],
  "nextPageToken": "A String", # A token to retrieve the next page of results. Pass this value in the ListClientUsersRequest.pageToken field in the subsequent call to the list method to retrieve the next page of results.
}

list_next()

Retrieves the next page of results.

        Args:
          previous_request: The request for the previous page. (required)
          previous_response: The response from the request for the previous page. (required)

        Returns:
          A request object that you can call 'execute()' on to request the next
          page. Returns None if there are no more items in the collection.