Search
K
Cipherscale API

UserDto

object

Complete user profile with authentication, authorization, and device information

idstring(uuid)required

Unique identifier for the user

createdAtstring(date-time)required

Timestamp when the user account was created

updatedAtstring(date-time)required

Timestamp when the user account was last modified

lastConnectionstring(date-time)

Timestamp of the user’s last network connection

emailstring

User’s email address used for authentication

statusstringrequired

Current status of the user account (active, inactive, pending, etc.)

firstNamestring

User’s first name

lastNamestring

User’s last name

isOwnerbooleanrequired

Whether this user is the tenant owner

maxDevicesnumberrequired

Maximum number of devices this user can register

imagestring

URL or path to the user’s profile image

rolesarray[object]required

User role definition with specific permissions and capabilities

Show Child Parameters
groupsarray[object]required

List of groups this user belongs to

Show Child Parameters
devicesarray[object]required

Device information including connection status, user association, and security posture

Show Child Parameters
Example

CreateUserDto

object
emailstringrequired
groupsarray[string](uuid)required
Example

PaginatedDto

object

UpdateUserDto

object
firstNamestring
lastNamestring
imagestring
Example

UpdateUserRolesDto

object
addedRolesarray[string]required
removedRolesarray[string]required
Example