com.google.api.services.cloudidentity.v1

Class CloudIdentity.Customers.Userinvitations

java.lang.Object

com.google.api.services.cloudidentity.v1.CloudIdentity.Customers.Userinvitations

Enclosing class:

CloudIdentity.Customers

public class CloudIdentity.Customers.Userinvitations
extends Object

The "userinvitations" collection of methods.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	CloudIdentity.Customers.Userinvitations.Cancel
class	CloudIdentity.Customers.Userinvitations.Get
class	CloudIdentity.Customers.Userinvitations.IsInvitableUser
class	CloudIdentity.Customers.Userinvitations.List
class	CloudIdentity.Customers.Userinvitations.Send

Constructor Summary

Constructors

Constructor and Description
Userinvitations()

Method Summary

Modifier and Type	Method and Description
CloudIdentity.Customers.Userinvitations.Cancel	cancel(String name, CancelUserInvitationRequest content) Cancels a UserInvitation that was already sent.
CloudIdentity.Customers.Userinvitations.Get	get(String name) Retrieves a UserInvitation resource.
CloudIdentity.Customers.Userinvitations.IsInvitableUser	isInvitableUser(String name) Verifies whether a user account is eligible to receive a UserInvitation (is an unmanaged account).
CloudIdentity.Customers.Userinvitations.List	list(String parent) Retrieves a list of UserInvitation resources.
CloudIdentity.Customers.Userinvitations.Send	send(String name, SendUserInvitationRequest content) Sends a UserInvitation to email.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Userinvitations

public Userinvitations()

Method Detail

cancel

public CloudIdentity.Customers.Userinvitations.Cancel cancel(String name,
                                                             CancelUserInvitationRequest content)
                                                      throws IOException

Cancels a UserInvitation that was already sent. Create a request for the method "userinvitations.cancel". This request holds the parameters needed by the cloudidentity server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

name - Required. `UserInvitation` name in the format `customers/{customer}/userinvitations/{user_email_address}`

content - the CancelUserInvitationRequest

Returns:

the request

Throws:

IOException

get

public CloudIdentity.Customers.Userinvitations.Get get(String name)
                                                throws IOException

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. Create a request for the method "userinvitations.get". This request holds the parameters needed by the cloudidentity server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

name - Required. `UserInvitation` name in the format `customers/{customer}/userinvitations/{user_email_address}`

Returns:

the request

Throws:

IOException

isInvitableUser

public CloudIdentity.Customers.Userinvitations.IsInvitableUser isInvitableUser(String name)
                                                                        throws IOException

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. Create a request for the method "userinvitations.isInvitableUser". This request holds the parameters needed by the cloudidentity server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

name - Required. `UserInvitation` name in the format `customers/{customer}/userinvitations/{user_email_address}`

Returns:

the request

Throws:

IOException

list

public CloudIdentity.Customers.Userinvitations.List list(String parent)
                                                  throws IOException

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. Create a request for the method "userinvitations.list". This request holds the parameters needed by the cloudidentity server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

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

Returns:

the request

Throws:

IOException

send

public CloudIdentity.Customers.Userinvitations.Send send(String name,
                                                         SendUserInvitationRequest content)
                                                  throws IOException

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. Create a request for the method "userinvitations.send". This request holds the parameters needed by the cloudidentity server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

name - Required. `UserInvitation` name in the format `customers/{customer}/userinvitations/{user_email_address}`

content - the SendUserInvitationRequest

Returns:

the request

Throws:

IOException