Resource: UserInvitation
The UserInvitation
resource represents an email that can be sent to an unmanaged user account inviting them to join the customer's Google Workspace or Cloud Identity account. An unmanaged account shares an email address domain with the Google Workspace or Cloud Identity account but is not managed by it yet. If the user accepts the UserInvitation
, the user account will become managed.
JSON representation |
---|
{
"name": string,
"state": enum ( |
Fields | |
---|---|
name |
Shall be of the form |
state |
State of the |
mails |
Number of invitation emails sent to the user. |
update |
Time when the A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: |
State
State of the invitation.
Enums | |
---|---|
STATE_UNSPECIFIED |
The default value. This value is used if the state is omitted. |
NOT_YET_SENT |
The UserInvitation has been created and is ready for sending as an email. |
INVITED |
The user has been invited by email. |
ACCEPTED |
The user has accepted the invitation and is part of the organization. |
DECLINED |
The user declined the invitation. |
Methods |
|
---|---|
|
Cancels a UserInvitation that was already sent. |
|
Retrieves a UserInvitation resource. |
|
Verifies whether a user account is eligible to receive a UserInvitation (is an unmanaged account). |
|
Retrieves a list of UserInvitation resources. |
|
Sends a UserInvitation to email. |