Stay organized with collectionsSave and categorize content based on your preferences.
Resource: UserInvitation
TheUserInvitationresource 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 theUserInvitation, the user account will become managed.
Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples:"2014-10-02T15:01:23Z","2014-10-02T15:01:23.045123456Z"or"2014-10-02T15:01:23+05:30".
State
State of the invitation.
Enums
STATE_UNSPECIFIED
The default value. This value is used if the state is omitted.
NOT_YET_SENT
TheUserInvitationhas 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.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-08-26 UTC."],[[["\u003cp\u003eThe \u003ccode\u003eUserInvitation\u003c/code\u003e resource represents an email invitation for unmanaged users to join a Google Workspace or Cloud Identity account, allowing them to become managed users upon acceptance.\u003c/p\u003e\n"],["\u003cp\u003eThe invitation's status can be tracked through its \u003ccode\u003estate\u003c/code\u003e, which can be \u003ccode\u003eNOT_YET_SENT\u003c/code\u003e, \u003ccode\u003eINVITED\u003c/code\u003e, \u003ccode\u003eACCEPTED\u003c/code\u003e, \u003ccode\u003eDECLINED\u003c/code\u003e, or \u003ccode\u003eSTATE_UNSPECIFIED\u003c/code\u003e, reflecting different stages of the invitation process.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003eUserInvitation\u003c/code\u003e resource contains fields such as \u003ccode\u003ename\u003c/code\u003e, \u003ccode\u003estate\u003c/code\u003e, \u003ccode\u003emailsSentCount\u003c/code\u003e, and \u003ccode\u003eupdateTime\u003c/code\u003e to identify and track the invitation's details and history.\u003c/p\u003e\n"],["\u003cp\u003eSeveral methods are available for managing \u003ccode\u003eUserInvitation\u003c/code\u003e resources, including the ability to cancel, retrieve, verify eligibility, list, and send invitations.\u003c/p\u003e\n"],["\u003cp\u003eAn unmanaged user shares an email address domain with the Google Workspace or Cloud Identity account but is not yet managed by it, which means that once the user accepts the invitation, they will become a managed account.\u003c/p\u003e\n"]]],[],null,["# REST Resource: customers.userinvitations\n\nResource: UserInvitation\n------------------------\n\nThe `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.\n\nState\n-----\n\nState of the invitation."]]
