Class CustomersResource.UserinvitationsResource

The "userinvitations" collection of methods.

Inheritance
object
CustomersResource.UserinvitationsResource
Inherited Members
Namespace: Google.Apis.CloudIdentity.v1beta1
Assembly: Google.Apis.CloudIdentity.v1beta1.dll
Syntax
public class CustomersResource.UserinvitationsResource

Constructors

UserinvitationsResource(IClientService)

Constructs a new resource.

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

Methods

Cancel(CancelUserInvitationRequest, string)

Cancels a UserInvitation that was already sent.

Declaration
public virtual CustomersResource.UserinvitationsResource.CancelRequest Cancel(CancelUserInvitationRequest body, string name)
Parameters
Type Name Description
CancelUserInvitationRequest body

The body of the request.
string name

Required. UserInvitation name in the format customers/{customer}/userinvitations/{user_email_address}
Returns
Type Description
CustomersResource.UserinvitationsResource.CancelRequest

Get(string)

Retrieves a UserInvitation resource. 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.

Declaration
public virtual CustomersResource.UserinvitationsResource.GetRequest Get(string name)
Parameters
Type Name Description
string name

Required. UserInvitation name in the format customers/{customer}/userinvitations/{user_email_address}
Returns
Type Description
CustomersResource.UserinvitationsResource.GetRequest

IsInvitableUser(string)

Verifies whether a user account is eligible to receive a UserInvitation (is an unmanaged account). Eligibility is based on the following criteria: * the email address is a consumer account and it's the primary email address of the account, and * the domain of the email address matches an existing verified Google Workspace or Cloud Identity domain If both conditions are met, the user is eligible. Note: This method is not supported for Workspace Essentials customers.

Declaration
public virtual CustomersResource.UserinvitationsResource.IsInvitableUserRequest IsInvitableUser(string name)
Parameters
Type Name Description
string name

Required. UserInvitation name in the format customers/{customer}/userinvitations/{user_email_address}
Returns
Type Description
CustomersResource.UserinvitationsResource.IsInvitableUserRequest

List(string)

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.

Declaration
public virtual CustomersResource.UserinvitationsResource.ListRequest List(string parent)
Parameters
Type Name Description
string parent

Required. The customer ID of the Google Workspace or Cloud Identity account the UserInvitation resources are associated with.
Returns
Type Description
CustomersResource.UserinvitationsResource.ListRequest

Send(SendUserInvitationRequest, string)

Sends a UserInvitation to email. If the UserInvitation does not exist for this request and it is a valid request, the request creates a UserInvitation. Note: The get and list methods have a 48-hour delay where newly-created consumer accounts will not appear in the results. You can still send a UserInvitation to those accounts if you know the unmanaged email address and IsInvitableUser==True.

Declaration
public virtual CustomersResource.UserinvitationsResource.SendRequest Send(SendUserInvitationRequest body, string name)
Parameters
Type Name Description
SendUserInvitationRequest body

The body of the request.
string name

Required. UserInvitation name in the format customers/{customer}/userinvitations/{user_email_address}
Returns
Type Description
CustomersResource.UserinvitationsResource.SendRequest