userinvitations

Creates, updates, deletes, gets or lists a userinvitations resource.

Overview

Name	userinvitations
Type	Resource
Id	google.cloudidentity.userinvitations

Fields

Name	Datatype	Description
name	string	Shall be of the form customers/{customer}/userinvitations/{user_email_address}.
mailsSentCount	string	Number of invitation emails sent to the user.
state	string	State of the UserInvitation.
updateTime	string	Time when the UserInvitation was last updated.

Methods

Name	Accessible by	Required Params	Description
get	SELECT	customersId, userinvitationsId	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.
list	SELECT	customersId	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.
cancel	EXEC	customersId, userinvitationsId	Cancels a UserInvitation that was already sent.
is_invitable_user	EXEC	customersId, userinvitationsId	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.
send	EXEC	customersId, userinvitationsId	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.

SELECT examples

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.

SELECT
name,
mailsSentCount,
state,
updateTime
FROM google.cloudidentity.userinvitations
WHERE customersId = '{{ customersId }}';