TenantUserDto
DTO for a user within a tenant, including their role and basic information.
Properties
| Name | Type | Description |
|---|---|---|
| code | string | The unique code for this user within the tenant |
The unique code for this user within the tenant | ||
| displayName | string | The display name for the user (returns full name if available, otherwise email) |
The display name for the user (returns full name if available, otherwise email) | ||
| string | The user's email address | |
The user's email address | ||
| firstName | string | The user's first name |
The user's first name | ||
| lastName | string | The user's last name |
The user's last name | ||
| isSuperAdmin | boolean | Whether the user is a super admin |
Whether the user is a super admin | ||
| isSupportAccess | boolean | Whether this user is accessing the tenant via support access (not a regular team member) |
Whether this user is accessing the tenant via support access (not a regular team member) | ||
| avatar | string | The user's avatar URL |
The user's avatar URL | ||
| userCode | string | The global user code, for linking to admin user records |
The global user code, for linking to admin user records | ||
| lastLogin | string | The user's last login timestamp |
The user's last login timestamp | ||
| authProvider | string | The authentication provider type (Local, Auth0, Google, Facebook, Xero) |
The authentication provider type (Local, Auth0, Google, Facebook, Xero) | ||
| status | enum | Created Invited Active Disabled Declined Deleted |
Created Invited Active Disabled Declined Deleted | ||
| invitationExpiresOn | string | When the invitation expires (null if not invited or if joined directly) |
When the invitation expires (null if not invited or if joined directly) | ||
| invitationAcceptedAt | string | When the invitation was accepted (null if still pending) |
When the invitation was accepted (null if still pending) | ||
| tenant | TenantInfo | |
JSON Example
{
"code": "string",
"displayName": "string",
"email": "user@example.com",
"firstName": "string",
"lastName": "string"
}