Caution: You are viewing documentation for the API's REST interface. Most of our official client libraries use gRPC. See the
REST Introduction for details.
Send feedback
CustomerUserAccessInvitation
Stay organized with collections
Save and categorize content based on your preferences.
Represent an invitation to a new user on this customer account.
JSON representation
{
"resourceName" : string ,
"invitationId" : string ,
"accessRole" : enum (AccessRole
) ,
"emailAddress" : string ,
"creationDateTime" : string ,
"invitationStatus" : enum (AccessInvitationStatus
)
}
Fields
resourceName
string
Immutable. Name of the resource. Resource names have the form: customers/{customerId}/customerUserAccessInvitations/{invitationId}
invitationId
string (int64 format)
Output only. The ID of the invitation. This field is read-only.
accessRole
enum (AccessRole
)
Immutable. Access role of the user.
emailAddress
string
Immutable. Email address the invitation was sent to. This can differ from the email address of the account that accepts the invite.
creationDateTime
string
Output only. Time invitation was created. This field is read-only. The format is "YYYY-MM-DD HH:MM:SS". Examples: "2018-03-05 09:15:00" or "2018-02-01 14:34:30"
invitationStatus
enum (AccessInvitationStatus
)
Output only. Invitation status of the user.
AccessInvitationStatus
Possible access invitation status of a user
Enums
UNSPECIFIED
Not specified.
UNKNOWN
Used for return value only. Represents value unknown in this version.
PENDING
The initial state of an invitation, before being acted upon by anyone.
DECLINED
Invitation process was terminated by the email recipient. No new user was created.
EXPIRED
Invitation URLs expired without being acted upon. No new user can be created. Invitations expire 20 days after creation.
Send feedback
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License , and code samples are licensed under the Apache 2.0 License . For details, see the Google Developers Site Policies . Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-04-23 UTC.
[{
"type": "thumb-down",
"id": "missingTheInformationINeed",
"label":"Missing the information I need"
},{
"type": "thumb-down",
"id": "tooComplicatedTooManySteps",
"label":"Too complicated / too many steps"
},{
"type": "thumb-down",
"id": "outOfDate",
"label":"Out of date"
},{
"type": "thumb-down",
"id": "samplesCodeIssue",
"label":"Samples / code issue"
},{
"type": "thumb-down",
"id": "otherDown",
"label":"Other"
}]
[{
"type": "thumb-up",
"id": "easyToUnderstand",
"label":"Easy to understand"
},{
"type": "thumb-up",
"id": "solvedMyProblem",
"label":"Solved my problem"
},{
"type": "thumb-up",
"id": "otherUp",
"label":"Other"
}]
Need to tell us more?