API Docs / Schemas / CreateTenantUserRequest

CreateTenantUserRequest

DTO for creating a user within a tenant. Inherits update fields and adds email/name for creation.

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

email*string
firstNamestring

The user's first name (required for creating new users)

The user's first name (required for creating new users)

lastNamestring

The user's last name (required for creating new users)

The user's last name (required for creating new users)

JSON Example

{
  "roleType": "System",
  "roleId": 0,
  "systemRoleType": "Admin",
  "isClientManager": false,
  "isPartner": false,
  "email": "user@example.com"
}

Used By Operations