Class GroupsResource.ListRequest
Retrieves all groups of a domain or of a user given a userKey (paginated).
Inheritance
Inherited Members
Namespace: Google.Apis.Admin.Directory.directory_v1
Assembly: Google.Apis.Admin.Directory.directory_v1.dll
Syntax
public class GroupsResource.ListRequest : DirectoryBaseServiceRequest<Groups>, IClientServiceRequest<Groups>, IClientServiceRequestConstructors
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 Google Workspace account. In case of a multi-domain account, to fetch
all groups for a customer, use 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. You must provide either the customer or the
domain parameter.
Declaration
[RequestParameter("customer", RequestParameterType.Query)]
public virtual string Customer { get; set; }Property Value
| Type | Description |
|---|---|
| string |
Domain
The domain name. Use this field to get groups from only one domain. To return all domains for a customer
account, use the customer query parameter instead.
Declaration
[RequestParameter("domain", RequestParameterType.Query)]
public virtual string Domain { get; set; }Property Value
| Type | Description |
|---|---|
| string |
HttpMethod
Gets the HTTP method.
Declaration
public override string HttpMethod { get; }Property Value
| Type | Description |
|---|---|
| string |
Overrides
MaxResults
Maximum number of results to return. Max allowed value is 200.
Declaration
[RequestParameter("maxResults", RequestParameterType.Query)]
public virtual int? MaxResults { get; set; }Property Value
| Type | Description |
|---|---|
| int? |
MethodName
Gets the method name.
Declaration
public override string MethodName { get; }Property Value
| Type | Description |
|---|---|
| string |
Overrides
OrderBy
Column to use for sorting results
Declaration
[RequestParameter("orderBy", RequestParameterType.Query)]
public virtual GroupsResource.ListRequest.OrderByEnum? OrderBy { get; set; }Property Value
| Type | Description |
|---|---|
| GroupsResource.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 |
|---|---|
| string |
Query
Query string search. Should be of the form "". Complete documentation is at https: //developers.google.com/admin-sdk/directory/v1/guides/search-groups
Declaration
[RequestParameter("query", RequestParameterType.Query)]
public virtual string Query { get; set; }Property Value
| Type | Description |
|---|---|
| string |
RestPath
Gets the REST path.
Declaration
public override string RestPath { get; }Property Value
| Type | Description |
|---|---|
| string |
Overrides
SortOrder
Whether to return results in ascending or descending order. Only of use when orderBy is also used
Declaration
[RequestParameter("sortOrder", RequestParameterType.Query)]
public virtual GroupsResource.ListRequest.SortOrderEnum? SortOrder { get; set; }Property Value
| Type | Description |
|---|---|
| GroupsResource.ListRequest.SortOrderEnum? |
UserKey
Email or immutable ID of the user if only those groups are to be listed, the given user is a member of.
If it's an ID, it should match with the ID of the user object. Cannot be used with the customer
parameter.
Declaration
[RequestParameter("userKey", RequestParameterType.Query)]
public virtual string UserKey { get; set; }Property Value
| Type | Description |
|---|---|
| string |
Methods
InitParameters()
Initializes List parameter list.
Declaration
protected override void InitParameters()