IUserInvitation
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Invitation of a user to the organization.
export interface IUserInvitation
Properties
Property | Modifiers | Type | Description |
|---|---|---|---|
string | (ALPHA) | ||
string | (ALPHA) (Optional) | ||
boolean | (ALPHA) (Optional) Send the invitation email again even if a pending invitation exists. | ||
string | (ALPHA) (Optional) | ||
string | (ALPHA) |
Property details
IUserInvitation.emailpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
email: string;
IUserInvitation.firstNamepropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
firstName?: string;
IUserInvitation.forceSendpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Send the invitation email again even if a pending invitation exists.
forceSend?: boolean;
IUserInvitation.lastNamepropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
lastName?: string;
IUserInvitation.userIdpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
userId: string;