Users
User account management and authentication
Get User Details
Retrieves comprehensive details of a specific user including their profile information, assigned roles, group memberships, associated devices, and connection status. This endpoint is essential for user management and access control operations.
get
https://public-api.cipherscale.com/qa/tenants/users/{id}
Path Parameters
idstring(uuid)required
The unique identifier (UUID) of the user
Example:123e4567-e89b-12d3-a456-426614174000
Response
application/json
Response
application/json
Successfully retrieved the user
UserDto
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
maxDevicesnumber | nullrequired
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
get/tenants/users/{id}
Authentication
Path Parameters
application/json
Update User Profile
Updates user profile information including first name, last name, and profile image. This operation allows administrators to maintain accurate user records and personalization settings.
put
https://public-api.cipherscale.com/qa/tenants/users/{id}
Path Parameters
idstringrequired
Body
application/json
Body
application/json
UpdateUserDto
firstNamestring
lastNamestring
imagestring
Response
application/json
Response
application/json
UserDto
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
maxDevicesnumber | nullrequired
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
put/tenants/users/{id}
Authentication
Path Parameters
Body
{}
application/json
Delete User Account
Permanently removes a user account from the tenant. This operation will also deactivate all associated devices and revoke all access permissions. This action cannot be undone.
delete
https://public-api.cipherscale.com/qa/tenants/users/{id}
Path Parameters
idstring(uuid)required
The unique identifier (UUID) of the user to delete
Response
Response
Successfully deleted the user
delete/tenants/users/{id}
Authentication
Path Parameters
Deactivate User Account
Temporarily disables a user account, preventing them from accessing the network while preserving their data and settings. Deactivated users can be reactivated later. This is useful for temporary suspensions or maintenance.
patch
https://public-api.cipherscale.com/qa/tenants/users/{id}/deactivate
Path Parameters
idstringrequired
Response
application/json
Response
application/json
UserDto
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
maxDevicesnumber | nullrequired
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
patch/tenants/users/{id}/deactivate
Authentication
Path Parameters
application/json