Table of Contents

Class UsersResource.ListRequest

Namespace
Google.Apis.Admin.Directory.directory_v1
Assembly
Google.Apis.Admin.Directory.directory_v1.dll

Retrieves a paginated list of either deleted users or all users in a domain.

public class UsersResource.ListRequest : DirectoryBaseServiceRequest<Users>
Inheritance
UsersResource.ListRequest
Inherited Members

Constructors

ListRequest(IClientService)

Constructs a new List request.

public ListRequest(IClientService service)

Parameters

service IClientService

Properties

CustomFieldMask

A comma-separated list of schema names. All fields from these schemas are fetched. This should only be set when projection=custom.

public virtual string CustomFieldMask { get; set; }

Property Value

string

Customer

The unique ID for the customer's Google Workspace account. In case of a multi-domain account, to fetch all groups for a customer, fill this field instead of domain. You can also use the my_customer alias to represent your account's customerId. The customerId is also returned as part of the Users resource. Either the customer or the domain parameter must be provided.

public virtual string Customer { get; set; }

Property Value

string

Domain

The domain name. Use this field to get fields from only one domain. To return all domains for a customer account, use the customer query parameter instead. Either the customer or the domain parameter must be provided.

public virtual string Domain { get; set; }

Property Value

string

Event

Event on which subscription is intended (if subscribing)

public virtual UsersResource.ListRequest.EventEnum? Event { get; set; }

Property Value

UsersResource.ListRequest.EventEnum?

HttpMethod

Gets the HTTP method.

public override string HttpMethod { get; }

Property Value

string

MaxResults

Maximum number of results to return.

public virtual int? MaxResults { get; set; }

Property Value

int?

MethodName

Gets the method name.

public override string MethodName { get; }

Property Value

string

OrderBy

Property to use for sorting results.

public virtual UsersResource.ListRequest.OrderByEnum? OrderBy { get; set; }

Property Value

UsersResource.ListRequest.OrderByEnum?

PageToken

Token to specify next page in the list

public virtual string PageToken { get; set; }

Property Value

string

Projection

What subset of fields to fetch for this user.

public virtual UsersResource.ListRequest.ProjectionEnum? Projection { get; set; }

Property Value

UsersResource.ListRequest.ProjectionEnum?

Query

Query string for searching user fields. For more information on constructing user queries, see Search for Users.

public virtual string Query { get; set; }

Property Value

string

RestPath

Gets the REST path.

public override string RestPath { get; }

Property Value

string

ShowDeleted

If set to true, retrieves the list of deleted users. (Default: false)

public virtual string ShowDeleted { get; set; }

Property Value

string

SortOrder

Whether to return results in ascending or descending order.

public virtual UsersResource.ListRequest.SortOrderEnum? SortOrder { get; set; }

Property Value

UsersResource.ListRequest.SortOrderEnum?

ViewType

Whether to fetch the administrator-only or domain-wide public view of the user. For more information, see Retrieve a user as a non-administrator.

public virtual UsersResource.ListRequest.ViewTypeEnum? ViewType { get; set; }

Property Value

UsersResource.ListRequest.ViewTypeEnum?

Methods

InitParameters()

Initializes List parameter list.

protected override void InitParameters()