CreateTenantUserRequest
DTO for creating a user within a tenant. Inherits update fields and adds email/name for creation.
Properties
| Name | Type | Description |
|---|---|---|
| roleType | enum | System Custom |
System Custom | ||
| roleId | integer | The ID of the custom role (only used if RoleType is Custom) |
The ID of the custom role (only used if RoleType is Custom) | ||
| systemRoleType | enum | Admin StandardUser Viewer |
Admin StandardUser Viewer | ||
| isClientManager | boolean | Whether the user is a client manager within the tenant |
Whether the user is a client manager within the tenant | ||
| isPartner | boolean | Whether the user is a partner within the tenant |
Whether the user is a partner within the tenant | ||
| isAssociate | boolean | Whether the user is an associate within the tenant |
Whether the user is an associate within the tenant | ||
| isRestrictedToTeamClients | boolean | Whether the user can only see clients belonging to their teams |
Whether the user can only see clients belonging to their teams | ||
| isRestrictedToAssignedClients | boolean | Whether the user can only see clients where they are Manager, Partner, or Associate |
Whether the user can only see clients where they are Manager, Partner, or Associate | ||
| hourlyRate | number | Charge-out rate per hour for time tracking. |
Charge-out rate per hour for time tracking. | ||
| email* | string | |
| firstName | string | The user's first name (required for creating new users) |
The user's first name (required for creating new users) | ||
| lastName | string | The user's last name (required for creating new users) |
The user's last name (required for creating new users) | ||
| teamCodes | array of string | Optional list of team codes to assign the user to on creation |
Optional list of team codes to assign the user to on creation | ||
JSON Example
{
"roleType": "System",
"roleId": 0,
"systemRoleType": "Admin",
"isClientManager": false,
"isPartner": false,
"email": "user@example.com"
}