Class UsersResource.ListRequest

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

Inheritance
System.Object
ClientServiceRequest
ClientServiceRequest<Users>
DirectoryBaseServiceRequest<Users>
UsersResource.ListRequest
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.ToString()
Namespace: Google.Apis.Admin.Directory.directory_v1
Assembly: Google.Apis.Admin.Directory.directory_v1.dll
Syntax
public class ListRequest : DirectoryBaseServiceRequest<Users>, IClientServiceRequest<Users>, IClientServiceRequest

Constructors

ListRequest(IClientService)

Constructs a new List request.

Declaration
public ListRequest(IClientService service)
Parameters
Type Name Description
IClientService service

Properties

Customer

The unique ID for the customer's G Suite 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.

Declaration
[RequestParameter("customer", RequestParameterType.Query)]
public virtual string Customer { get; set; }
Property Value
Type Description
System.String

CustomFieldMask

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

Declaration
[RequestParameter("customFieldMask", RequestParameterType.Query)]
public virtual string CustomFieldMask { get; set; }
Property Value
Type Description
System.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.

Declaration
[RequestParameter("domain", RequestParameterType.Query)]
public virtual string Domain { get; set; }
Property Value
Type Description
System.String

HttpMethod

Gets the HTTP method.

Declaration
public override string HttpMethod { get; }
Property Value
Type Description
System.String
Overrides
Google.Apis.Requests.ClientServiceRequest<Google.Apis.Admin.Directory.directory_v1.Data.Users>.HttpMethod

MaxResults

Maximum number of results to return.

Declaration
[RequestParameter("maxResults", RequestParameterType.Query)]
public virtual int? MaxResults { get; set; }
Property Value
Type Description
System.Nullable<System.Int32>

MethodName

Gets the method name.

Declaration
public override string MethodName { get; }
Property Value
Type Description
System.String
Overrides
Google.Apis.Requests.ClientServiceRequest<Google.Apis.Admin.Directory.directory_v1.Data.Users>.MethodName

OrderBy

Property to use for sorting results.

Declaration
[RequestParameter("orderBy", RequestParameterType.Query)]
public virtual UsersResource.ListRequest.OrderByEnum? OrderBy { get; set; }
Property Value
Type Description
System.Nullable<UsersResource.ListRequest.OrderByEnum>

PageToken

Token to specify next page in the list

Declaration
[RequestParameter("pageToken", RequestParameterType.Query)]
public virtual string PageToken { get; set; }
Property Value
Type Description
System.String

Projection

What subset of fields to fetch for this user.

Declaration
[RequestParameter("projection", RequestParameterType.Query)]
public virtual UsersResource.ListRequest.ProjectionEnum? Projection { get; set; }
Property Value
Type Description
System.Nullable<UsersResource.ListRequest.ProjectionEnum>

Query

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

Declaration
[RequestParameter("query", RequestParameterType.Query)]
public virtual string Query { get; set; }
Property Value
Type Description
System.String

RestPath

Gets the REST path.

Declaration
public override string RestPath { get; }
Property Value
Type Description
System.String
Overrides
Google.Apis.Requests.ClientServiceRequest<Google.Apis.Admin.Directory.directory_v1.Data.Users>.RestPath

ShowDeleted

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

Declaration
[RequestParameter("showDeleted", RequestParameterType.Query)]
public virtual string ShowDeleted { get; set; }
Property Value
Type Description
System.String

SortOrder

Whether to return results in ascending or descending order.

Declaration
[RequestParameter("sortOrder", RequestParameterType.Query)]
public virtual UsersResource.ListRequest.SortOrderEnum? SortOrder { get; set; }
Property Value
Type Description
System.Nullable<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](/admin-sdk/directory/v1/guides/manage- users#retrieve_users_non_admin).

Declaration
[RequestParameter("viewType", RequestParameterType.Query)]
public virtual UsersResource.ListRequest.ViewTypeEnum? ViewType { get; set; }
Property Value
Type Description
System.Nullable<UsersResource.ListRequest.ViewTypeEnum>

Methods

InitParameters()

Initializes List parameter list.

Declaration
protected override void InitParameters()
Overrides
Google.Apis.Admin.Directory.directory_v1.DirectoryBaseServiceRequest<Google.Apis.Admin.Directory.directory_v1.Data.Users>.InitParameters()

Implements