Class DomainsResource.UsersResource

The "users" collection of methods.

Inheritance

object

DomainsResource.UsersResource

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Google.Apis.PostmasterTools.v2

Assembly: Google.Apis.PostmasterTools.v2.dll

Syntax

public class DomainsResource.UsersResource

Constructors

UsersResource(IClientService)

Constructs a new resource.

Declaration

public UsersResource(IClientService service)

Parameters

Type	Name	Description
IClientService	service

Methods

Create(CreateUserRequest, string)

Developer Preview: Creates a user, who has access to a domain. Returns INVALID_ARGUMENT if a user is not provided.

Declaration

public virtual DomainsResource.UsersResource.CreateRequest Create(CreateUserRequest body, string parent)

Parameters

Type	Name	Description
CreateUserRequest	body	The body of the request.
string	parent	Required. The parent resource where this user will be created. Format: domains/{domain}

Returns

Type	Description
DomainsResource.UsersResource.CreateRequest

Delete(string)

Developer Preview: Deletes a user from a domain. Returns NOT_FOUND if the user does not exist.

Declaration

public virtual DomainsResource.UsersResource.DeleteRequest Delete(string name)

Parameters

Type	Name	Description
string	name	Required. The resource name of the user to delete. Format: domains/{domain}/users/{user}

Returns

Type	Description
DomainsResource.UsersResource.DeleteRequest

Get(string)

Developer Preview: Retrieves detailed information about a user that has access to a domain. Returns NOT_FOUND if the user does not exist.

Declaration

public virtual DomainsResource.UsersResource.GetRequest Get(string name)

Parameters

Type	Name	Description
string	name	Required. The resource name of the user to retrieve. Format: domains/{domain}/users/{user}

Returns

Type	Description
DomainsResource.UsersResource.GetRequest

List(string)

Developer Preview: Lists the users that have access to a domain.

Declaration

public virtual DomainsResource.UsersResource.ListRequest List(string parent)

Parameters

Type	Name	Description
string	parent	Required. The parent resource name for which to list users. Format: domains/{domain}

Returns

Type	Description
DomainsResource.UsersResource.ListRequest

Patch(User, string)

Developer Preview: Updates a user for a domain. Only Owners and Admins can execute this RPC, only a user's domain permission will be allowed to be updated. Returns NOT_FOUND if the user does not exist. Returns INVALID_ARGUMENT if a permission is not provided or is PERMISSION_UNSPECIFIED, NONE, or OWNER.

Declaration

public virtual DomainsResource.UsersResource.PatchRequest Patch(User body, string name)

Parameters

Type	Name	Description
User	body	The body of the request.
string	name	Identifier. The resource name of the user. Format: users/{user} Note: {user} is the user's email address.

Returns

Type	Description
DomainsResource.UsersResource.PatchRequest