Retrieve either deleted users or all users in a domain (paginated) More...

Inheritance diagram for Google.Apis.Admin.Directory.directory_v1.UsersResource.ListRequest:

Public Types
enum	EventEnum { EventEnum.Add, EventEnum.Delete, EventEnum.MakeAdmin, EventEnum.Undelete, EventEnum.Update }
	Event on which subscription is intended (if subscribing) More...

enum	OrderByEnum { OrderByEnum.Email, OrderByEnum.FamilyName, OrderByEnum.GivenName }
	Column to use for sorting results More...

enum	ProjectionEnum { ProjectionEnum.Basic, ProjectionEnum.Custom, ProjectionEnum.Full }
	What subset of fields to fetch for this user. More...

enum	SortOrderEnum { SortOrderEnum.ASCENDING, SortOrderEnum.DESCENDING }
	Whether to return results in ascending or descending order. More...

enum	ViewTypeEnum { ViewTypeEnum.AdminView, ViewTypeEnum.DomainPublic }
	Whether to fetch the ADMIN_VIEW or DOMAIN_PUBLIC view of the user. More...

Public Member Functions
	ListRequest (Google.Apis.Services.IClientService service)
	Constructs a new List request. More...

Protected Member Functions
override void	InitParameters ()
	Initializes List parameter list. More...

Protected Member Functions inherited from Google.Apis.Admin.Directory.directory_v1.DirectoryBaseServiceRequest< Google.Apis.Admin.Directory.directory_v1.Data.Users >
	DirectoryBaseServiceRequest (Google.Apis.Services.IClientService service)
	Constructs a new DirectoryBaseServiceRequest instance. More...

override void	InitParameters ()
	Initializes Directory parameter list. More...

Properties
virtual string	CustomFieldMask `[get, set]`
	Comma-separated list of schema names. All fields from these schemas are fetched. This should only be set when projection=custom. More...

virtual string	Customer `[get, set]`
	Immutable ID of the G Suite account. In case of multi-domain, to fetch all users for a customer, fill this field instead of domain. More...

virtual string	Domain `[get, set]`
	Name of the domain. Fill this field to get users from only this domain. To return all users in a multi-domain fill customer field instead. More...

virtual System.Nullable< EventEnum >	Event `[get, set]`
	Event on which subscription is intended (if subscribing) More...

virtual System.Nullable< int >	MaxResults `[get, set]`
	Maximum number of results to return. More...

virtual System.Nullable< OrderByEnum >	OrderBy `[get, set]`
	Column to use for sorting results More...

virtual string	PageToken `[get, set]`
	Token to specify next page in the list More...

virtual System.Nullable< ProjectionEnum >	Projection `[get, set]`
	What subset of fields to fetch for this user. More...

virtual string	Query `[get, set]`
	Query string search. Should be of the form "". Complete documentation is at https://developers.google.com/admin-sdk/directory/v1/guides/search-users More...

virtual string	ShowDeleted `[get, set]`
	If set to true, retrieves the list of deleted users. (Default: false) More...

virtual System.Nullable< SortOrderEnum >	SortOrder `[get, set]`
	Whether to return results in ascending or descending order. More...

virtual System.Nullable< ViewTypeEnum >	ViewType `[get, set]`
	Whether to fetch the ADMIN_VIEW or DOMAIN_PUBLIC view of the user. More...

override string	MethodName `[get]`
	Gets the method name. More...

override string	HttpMethod `[get]`
	summary>Gets the REST path. More...

override string	RestPath `[get]`

Properties inherited from Google.Apis.Admin.Directory.directory_v1.DirectoryBaseServiceRequest< Google.Apis.Admin.Directory.directory_v1.Data.Users >
virtual System.Nullable< AltEnum >	Alt `[get, set]`
	Data format for the response. More...

virtual string	Fields `[get, set]`
	Selector specifying which fields to include in a partial response. More...

virtual string	Key `[get, set]`
	API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. More...

virtual string	OauthToken `[get, set]`
	OAuth 2.0 token for the current user. More...

virtual System.Nullable< bool >	PrettyPrint `[get, set]`
	Returns response with indentations and line breaks. More...

virtual string	QuotaUser `[get, set]`
	An opaque string that represents a user for quota purposes. Must not exceed 40 characters. More...

virtual string	UserIp `[get, set]`
	Deprecated. Please use quotaUser instead. More...

Detailed Description

Retrieve either deleted users or all users in a domain (paginated)

Member Enumeration Documentation

◆ EventEnum

enum Google.Apis.Admin.Directory.directory_v1.UsersResource.ListRequest.EventEnum

strong

Event on which subscription is intended (if subscribing)

Enumerator
Add	User Created Event
Delete	User Deleted Event
MakeAdmin	User Admin Status Change Event
Undelete	User Undeleted Event
Update	User Updated Event

◆ OrderByEnum

enum Google.Apis.Admin.Directory.directory_v1.UsersResource.ListRequest.OrderByEnum

strong

Column to use for sorting results

Enumerator
Email	Primary email of the user.
FamilyName	User's family name.
GivenName	User's given name.

◆ ProjectionEnum

enum Google.Apis.Admin.Directory.directory_v1.UsersResource.ListRequest.ProjectionEnum

strong

What subset of fields to fetch for this user.

Enumerator
Basic	Do not include any custom fields for the user.
Custom	Include custom fields from schemas mentioned in customFieldMask.
Full	Include all fields associated with this user.

◆ SortOrderEnum

enum Google.Apis.Admin.Directory.directory_v1.UsersResource.ListRequest.SortOrderEnum

strong

Whether to return results in ascending or descending order.

Enumerator
ASCENDING	Ascending order.
DESCENDING	Descending order.

◆ ViewTypeEnum

enum Google.Apis.Admin.Directory.directory_v1.UsersResource.ListRequest.ViewTypeEnum

strong

Whether to fetch the ADMIN_VIEW or DOMAIN_PUBLIC view of the user.

Enumerator
AdminView	Fetches the ADMIN_VIEW of the user.
DomainPublic	Fetches the DOMAIN_PUBLIC view of the user.

Constructor & Destructor Documentation

◆ ListRequest()

Google.Apis.Admin.Directory.directory_v1.UsersResource.ListRequest.ListRequest ( Google.Apis.Services.IClientService service )

inline

Constructs a new List request.

Member Function Documentation

◆ InitParameters()

override void Google.Apis.Admin.Directory.directory_v1.UsersResource.ListRequest.InitParameters ( )

inlineprotected

Initializes List parameter list.

Property Documentation

◆ Customer

virtual string Google.Apis.Admin.Directory.directory_v1.UsersResource.ListRequest.Customer

getset

Immutable ID of the G Suite account. In case of multi-domain, to fetch all users for a customer, fill this field instead of domain.

◆ CustomFieldMask

virtual string Google.Apis.Admin.Directory.directory_v1.UsersResource.ListRequest.CustomFieldMask

getset

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

◆ Domain

virtual string Google.Apis.Admin.Directory.directory_v1.UsersResource.ListRequest.Domain

getset

Name of the domain. Fill this field to get users from only this domain. To return all users in a multi-domain fill customer field instead.

◆ Event

virtual System.Nullable<EventEnum> Google.Apis.Admin.Directory.directory_v1.UsersResource.ListRequest.Event

getset

Event on which subscription is intended (if subscribing)

◆ HttpMethod

override string Google.Apis.Admin.Directory.directory_v1.UsersResource.ListRequest.HttpMethod

get

summary>Gets the REST path.

◆ MaxResults

virtual System.Nullable<int> Google.Apis.Admin.Directory.directory_v1.UsersResource.ListRequest.MaxResults

getset

Maximum number of results to return.

[default: 100] [minimum: 1] [maximum: 500]

◆ MethodName

override string Google.Apis.Admin.Directory.directory_v1.UsersResource.ListRequest.MethodName

get

Gets the method name.

summary>Gets the HTTP method.

◆ OrderBy

virtual System.Nullable<OrderByEnum> Google.Apis.Admin.Directory.directory_v1.UsersResource.ListRequest.OrderBy

getset

Column to use for sorting results

◆ PageToken

virtual string Google.Apis.Admin.Directory.directory_v1.UsersResource.ListRequest.PageToken

getset

Token to specify next page in the list

◆ Projection

virtual System.Nullable<ProjectionEnum> Google.Apis.Admin.Directory.directory_v1.UsersResource.ListRequest.Projection

getset

What subset of fields to fetch for this user.

[default: basic]

◆ Query

virtual string Google.Apis.Admin.Directory.directory_v1.UsersResource.ListRequest.Query

getset

Query string search. Should be of the form "". Complete documentation is at https://developers.google.com/admin-sdk/directory/v1/guides/search-users

◆ ShowDeleted

virtual string Google.Apis.Admin.Directory.directory_v1.UsersResource.ListRequest.ShowDeleted

getset

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

◆ SortOrder

virtual System.Nullable<SortOrderEnum> Google.Apis.Admin.Directory.directory_v1.UsersResource.ListRequest.SortOrder

getset

Whether to return results in ascending or descending order.

◆ ViewType

virtual System.Nullable<ViewTypeEnum> Google.Apis.Admin.Directory.directory_v1.UsersResource.ListRequest.ViewType

getset

Whether to fetch the ADMIN_VIEW or DOMAIN_PUBLIC view of the user.

[default: admin_view]

The documentation for this class was generated from the following file:

Google.Apis.Admin.Directory.directory_v1.cs

Public Types

Public Member Functions

Protected Member Functions

Properties

Detailed Description

Member Enumeration Documentation

◆ EventEnum

◆ OrderByEnum

◆ ProjectionEnum

◆ SortOrderEnum

◆ ViewTypeEnum

Constructor & Destructor Documentation

◆ ListRequest()

Member Function Documentation

◆ InitParameters()

Property Documentation

◆ Customer

◆ CustomFieldMask

◆ Domain

◆ Event

◆ HttpMethod

◆ MaxResults

◆ MethodName

◆ OrderBy

◆ PageToken

◆ Projection

◆ Query

◆ ShowDeleted

◆ SortOrder

◆ ViewType