Class BuyersResource.ClientsResource.UsersResource
The "users" collection of methods.
Inherited Members
Namespace: Google.Apis.AuthorizedBuyersMarketplace.v1alpha
Assembly: Google.Apis.AuthorizedBuyersMarketplace.v1alpha.dll
Syntax
public class BuyersResource.ClientsResource.UsersResource
Constructors
UsersResource(IClientService)
Constructs a new resource.
Declaration
public UsersResource(IClientService service)
Parameters
| Type | Name | Description |
|---|---|---|
| IClientService | service |
Methods
Activate(ActivateClientUserRequest, string)
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.
Declaration
public virtual BuyersResource.ClientsResource.UsersResource.ActivateRequest Activate(ActivateClientUserRequest body, string name)
Parameters
| Type | Name | Description |
|---|---|---|
| ActivateClientUserRequest | body | The body of the request. |
| string | name | Required. Format: |
Returns
| Type | Description |
|---|---|
| BuyersResource.ClientsResource.UsersResource.ActivateRequest |
Create(ClientUser, string)
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.
Declaration
public virtual BuyersResource.ClientsResource.UsersResource.CreateRequest Create(ClientUser body, string parent)
Parameters
| Type | Name | Description |
|---|---|---|
| ClientUser | body | The body of the request. |
| string | parent | Required. The name of the client. Format: |
Returns
| Type | Description |
|---|---|
| BuyersResource.ClientsResource.UsersResource.CreateRequest |
Deactivate(DeactivateClientUserRequest, string)
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.
Declaration
public virtual BuyersResource.ClientsResource.UsersResource.DeactivateRequest Deactivate(DeactivateClientUserRequest body, string name)
Parameters
| Type | Name | Description |
|---|---|---|
| DeactivateClientUserRequest | body | The body of the request. |
| string | name | Required. Format: |
Returns
| Type | Description |
|---|---|
| BuyersResource.ClientsResource.UsersResource.DeactivateRequest |
Delete(string)
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.
Declaration
public virtual BuyersResource.ClientsResource.UsersResource.DeleteRequest Delete(string name)
Parameters
| Type | Name | Description |
|---|---|---|
| string | name | Required. Format: |
Returns
| Type | Description |
|---|---|
| BuyersResource.ClientsResource.UsersResource.DeleteRequest |
Get(string)
Retrieves an existing client user.
Declaration
public virtual BuyersResource.ClientsResource.UsersResource.GetRequest Get(string name)
Parameters
| Type | Name | Description |
|---|---|---|
| string | name | Required. Format: |
Returns
| Type | Description |
|---|---|
| BuyersResource.ClientsResource.UsersResource.GetRequest |
List(string)
Lists all client users for a specified client.
Declaration
public virtual BuyersResource.ClientsResource.UsersResource.ListRequest List(string parent)
Parameters
| Type | Name | Description |
|---|---|---|
| string | parent | Required. The name of the client. Format: |
Returns
| Type | Description |
|---|---|
| BuyersResource.ClientsResource.UsersResource.ListRequest |