UserInvitationDto
An invitation to join a tenant, as the invited user sees it. The code is the one in the emailed link.
Properties
| Name | Type | Description |
|---|---|---|
| code* | string | The invitation's identifier |
The invitation's identifier | ||
| tenant* | string | The code of the tenant the invitation joins |
The code of the tenant the invitation joins | ||
| tenantName* | string | The tenant's name |
The tenant's name | ||
| email* | string | The email address it was sent to (accepting it joins the caller whatever their address) |
The email address it was sent to (accepting it joins the caller whatever their address) | ||
| role* | enum | The access level offered |
The access level offered | ||
| message | string | The personal message in the email |
The personal message in the email | ||
| status* | enum | Pending, Accepted, Rejected or Expired |
Pending, Accepted, Rejected or Expired | ||
| expiryDate* | string | When the invitation stops being acceptable |
When the invitation stops being acceptable | ||
| isExpired* | boolean | Whether the expiry date has passed |
Whether the expiry date has passed | ||
| invitedBy | string | Who sent it |
Who sent it | ||
| createdDate* | string | When it was sent |
When it was sent | ||
JSON Example
{
"code": "00000000-0000-0000-0000-000000000000",
"tenant": "string",
"tenantName": "string",
"email": "string",
"role": "None",
"status": "Pending",
"expiryDate": "2024-01-01T00:00:00Z",
"isExpired": false,
"createdDate": "2024-01-01T00:00:00Z"
}