Show / Hide Table of Contents

Class CustomersResource.UserinvitationsResource.ListRequest

Retrieves a list of UserInvitation resources. Note: New consumer accounts with the customer's verified domain created within the previous 48 hours will not appear in the result. This delay also applies to newly-verified domains.

Inheritance
object
ClientServiceRequest
ClientServiceRequest<ListUserInvitationsResponse>
CloudIdentityBaseServiceRequest<ListUserInvitationsResponse>
CustomersResource.UserinvitationsResource.ListRequest
Implements
IClientServiceRequest<ListUserInvitationsResponse>
IClientServiceRequest
Inherited Members
CloudIdentityBaseServiceRequest<ListUserInvitationsResponse>.Xgafv
CloudIdentityBaseServiceRequest<ListUserInvitationsResponse>.AccessToken
CloudIdentityBaseServiceRequest<ListUserInvitationsResponse>.Alt
CloudIdentityBaseServiceRequest<ListUserInvitationsResponse>.Callback
CloudIdentityBaseServiceRequest<ListUserInvitationsResponse>.Fields
CloudIdentityBaseServiceRequest<ListUserInvitationsResponse>.Key
CloudIdentityBaseServiceRequest<ListUserInvitationsResponse>.OauthToken
CloudIdentityBaseServiceRequest<ListUserInvitationsResponse>.PrettyPrint
CloudIdentityBaseServiceRequest<ListUserInvitationsResponse>.QuotaUser
CloudIdentityBaseServiceRequest<ListUserInvitationsResponse>.UploadType
CloudIdentityBaseServiceRequest<ListUserInvitationsResponse>.UploadProtocol
ClientServiceRequest<ListUserInvitationsResponse>.Execute()
ClientServiceRequest<ListUserInvitationsResponse>.ExecuteAsStream()
ClientServiceRequest<ListUserInvitationsResponse>.ExecuteAsync()
ClientServiceRequest<ListUserInvitationsResponse>.ExecuteAsync(CancellationToken)
ClientServiceRequest<ListUserInvitationsResponse>.ExecuteAsStreamAsync()
ClientServiceRequest<ListUserInvitationsResponse>.ExecuteAsStreamAsync(CancellationToken)
ClientServiceRequest<ListUserInvitationsResponse>.CreateRequest(bool?)
ClientServiceRequest<ListUserInvitationsResponse>.GenerateRequestUri()
ClientServiceRequest<ListUserInvitationsResponse>.GetBody()
ClientServiceRequest<ListUserInvitationsResponse>.GetDefaultETagAction(string)
ClientServiceRequest<ListUserInvitationsResponse>.ETagAction
ClientServiceRequest<ListUserInvitationsResponse>.ModifyRequest
ClientServiceRequest<ListUserInvitationsResponse>.ValidateParameters
ClientServiceRequest<ListUserInvitationsResponse>.ApiVersion
ClientServiceRequest<ListUserInvitationsResponse>.RequestParameters
ClientServiceRequest<ListUserInvitationsResponse>.Service
ClientServiceRequest._unsuccessfulResponseHandlers
ClientServiceRequest._exceptionHandlers
ClientServiceRequest._executeInterceptors
ClientServiceRequest.AddUnsuccessfulResponseHandler(IHttpUnsuccessfulResponseHandler)
ClientServiceRequest.AddExceptionHandler(IHttpExceptionHandler)
ClientServiceRequest.AddExecuteInterceptor(IHttpExecuteInterceptor)
ClientServiceRequest.Credential
object.Equals(object)
object.Equals(object, object)
object.GetHashCode()
object.GetType()
object.MemberwiseClone()
object.ReferenceEquals(object, object)
object.ToString()
Namespace: Google.Apis.CloudIdentity.v1
Assembly: Google.Apis.CloudIdentity.v1.dll
Syntax
public class CustomersResource.UserinvitationsResource.ListRequest : CloudIdentityBaseServiceRequest<ListUserInvitationsResponse>, IClientServiceRequest<ListUserInvitationsResponse>, IClientServiceRequest

Constructors

ListRequest(IClientService, string)

Constructs a new List request.

Declaration
public ListRequest(IClientService service, string parent)
Parameters
Type Name Description
IClientService service
string parent

Properties

Filter

Optional. A query string for filtering UserInvitation results by their current state, in the format: "state=='invited'".

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

HttpMethod

Gets the HTTP method.

Declaration
public override string HttpMethod { get; }
Property Value
Type Description
string
Overrides
ClientServiceRequest<ListUserInvitationsResponse>.HttpMethod

MethodName

Gets the method name.

Declaration
public override string MethodName { get; }
Property Value
Type Description
string
Overrides
ClientServiceRequest<ListUserInvitationsResponse>.MethodName

OrderBy

Optional. The sort order of the list results. You can sort the results in descending order based on either email or last update timestamp but not both, using order_by="email desc". Currently, sorting is supported for update_time asc, update_time desc, email asc, and email desc. If not specified, results will be returned based on email asc order.

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

PageSize

Optional. The maximum number of UserInvitation resources to return. If unspecified, at most 100 resources will be returned. The maximum value is 200; values above 200 will be set to 200.

Declaration
[RequestParameter("pageSize", RequestParameterType.Query)]
public virtual int? PageSize { get; set; }
Property Value
Type Description
int?

PageToken

Optional. A page token, received from a previous ListUserInvitations call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListBooks must match the call that provided the page token.

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

Parent

Required. The customer ID of the Google Workspace or Cloud Identity account the UserInvitation resources are associated with.

Declaration
[RequestParameter("parent", RequestParameterType.Path)]
public virtual string Parent { get; }
Property Value
Type Description
string

RestPath

Gets the REST path.

Declaration
public override string RestPath { get; }
Property Value
Type Description
string
Overrides
ClientServiceRequest<ListUserInvitationsResponse>.RestPath

Methods

InitParameters()

Initializes List parameter list.

Declaration
protected override void InitParameters()
Overrides
CloudIdentityBaseServiceRequest<ListUserInvitationsResponse>.InitParameters()

Implements

IClientServiceRequest<TResponse>
IClientServiceRequest
In this article
Back to top Generated by DocFX