CustomersUserinvitations
class CustomersUserinvitations extends Resource (View source)
The "userinvitations" collection of methods.
Typical usage is:
$cloudidentityService = new Google\Service\CloudIdentity(...);
$userinvitations = $cloudidentityService->customers_userinvitations;Methods
Cancels a UserInvitation that was already sent. (userinvitations.cancel)
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.
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. (userinvitations.isInvitableUser)
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.
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. (userinvitations.send)
Details
Operation
cancel(string $name, CancelUserInvitationRequest $postBody, array $optParams = [])
Cancels a UserInvitation that was already sent. (userinvitations.cancel)
UserInvitation
get(string $name, array $optParams = [])
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.
(userinvitations.get)
IsInvitableUserResponse
isInvitableUser(string $name, array $optParams = [])
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. (userinvitations.isInvitableUser)
ListUserInvitationsResponse
listCustomersUserinvitations(string $parent, array $optParams = [])
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.
(userinvitations.listCustomersUserinvitations)
Operation
send(string $name, SendUserInvitationRequest $postBody, array $optParams = [])
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. (userinvitations.send)