API Docs / Schemas / UpdateTenantUserRequest

UpdateTenantUserRequest

DTO for Updating a user within a tenant. Does not include email as it cannot be changed.
FirstName/LastName are managed via User updates and synced to TenantUser automatically.

Properties

Name Type Description
roleTypeenum

System Custom

System Custom

roleIdinteger

The ID of the custom role (only used if RoleType is Custom)

The ID of the custom role (only used if RoleType is Custom)

systemRoleTypeenum

Admin Manager User Viewer

Admin Manager User Viewer

isClientManagerboolean

Whether the user is a client manager within the tenant

Whether the user is a client manager within the tenant

isPartnerboolean

Whether the user is a partner within the tenant

Whether the user is a partner within the tenant

isAssociateboolean

Whether the user is an associate within the tenant

Whether the user is an associate within the tenant

JSON Example

{
  "roleType": "System",
  "roleId": 0,
  "systemRoleType": "Admin",
  "isClientManager": false,
  "isPartner": false
}

Used By Operations