userinvitations

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

Overview

Name	userinvitations
Type	Resource
Id	google.cloudidentity.userinvitations

Fields

The following fields are returned by SELECT queries:

get

Successful response

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

list

Successful response

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

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional 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	pageSize, pageToken, filter, orderBy	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.
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.
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.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
customersId	string
userinvitationsId	string
filter	string
orderBy	string
pageSize	integer (int32)
pageToken	string

SELECT examples

get

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.

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

list

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 }}' -- required
AND pageSize = '{{ pageSize }}'
AND pageToken = '{{ pageToken }}'
AND filter = '{{ filter }}'
AND orderBy = '{{ orderBy }}';

Lifecycle Methods

send

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.

EXEC google.cloudidentity.userinvitations.send 
@customersId='{{ customersId }}' --required, 
@userinvitationsId='{{ userinvitationsId }}' --required;

cancel

Cancels a UserInvitation that was already sent.

EXEC google.cloudidentity.userinvitations.cancel 
@customersId='{{ customersId }}' --required, 
@userinvitationsId='{{ userinvitationsId }}' --required;

is_invitable_user

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.

EXEC google.cloudidentity.userinvitations.is_invitable_user 
@customersId='{{ customersId }}' --required, 
@userinvitationsId='{{ userinvitationsId }}' --required;