REST Resource: customers.userinvitations

Stay organized with collections Save and categorize content based on your preferences.

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 (State),
  "mailsSentCount": string,
  "updateTime": string
}
Fields
name

string

Shall be of the form customers/{customer}/userinvitations/{user_email_address}.

state

enum (State)

State of the UserInvitation.

mailsSentCount

string (int64 format)

Number of invitation emails sent to the user.

updateTime

string (Timestamp format)

Time when the UserInvitation was last updated.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".

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

cancel

Cancels a UserInvitation that was already sent.

get

Retrieves a UserInvitation resource.

isInvitableUser

Verifies whether a user account is eligible to receive a UserInvitation (is an unmanaged account).

list

Retrieves a list of UserInvitation resources.

send

Sends a UserInvitation to email.