idstringrequired
Modify User Role Assignments
Adds or removes roles from a user’s account. This operation allows administrators to dynamically adjust user permissions by modifying their role assignments. Changes take effect immediately and affect the user’s access to system resources.
patch
https://public-api.cipherscale.com/qa/tenants/users/{id}/roles
Path Parameters
Body
application/json
Body
application/json
UpdateUserRolesDto
addedRolesarray[string]required
removedRolesarray[string]required
Response
Response
patch/tenants/users/{id}/roles
Authentication
Path Parameters
Body
{
"addedRoles": [
"[]"
],
"removedRoles": [
"[]"
]
}
Add User to Group
Associates a user with a specific group, which may grant them additional roles and permissions based on the group’s configuration. Group membership can affect access policies and resource availability.
post
https://public-api.cipherscale.com/qa/tenants/users/{id}/groups
Path Parameters
idstringrequired
Body
application/json
Body
application/json
groupIdstring(uuid)required
The unique identifier of the group to add the user to
Response
Response
post/tenants/users/{id}/groups
Authentication
Path Parameters
Body
{
"groupId": "groupId"
}
Remove User from Group
Disassociates a user from a specific group, which may revoke roles and permissions that were granted through group membership. This operation helps maintain proper access control and organizational structure.
delete
https://public-api.cipherscale.com/qa/tenants/users/{id}/groups/{groupId}
Path Parameters
idstringrequired
groupIdstringrequired
Response
Response
delete/tenants/users/{id}/groups/{groupId}
Authentication
Path Parameters
List All Users
Retrieves a paginated list of all users within the tenant, with support for sorting, filtering, and search functionality. This endpoint is essential for user management dashboards and administrative operations.
get
https://public-api.cipherscale.com/qa/tenants/users
Query Parameters
sortarray[string]
limitnumber
offsetnumber
Response
application/json
Response
application/json
Successfully retrieved users
PaginatedDto
PaginatedDtoobject
get/tenants/users
Authentication
Query Parameters
application/json
Create New Users
Creates one or more user accounts for the tenant. Supports bulk creation of up to 100 users in a single request. New users will receive invitation emails to complete their account setup.
post
https://public-api.cipherscale.com/qa/tenants/users
Body
application/json
Body
application/json
User data to create. Can be a single user object or an array of user objects (max 100).
One Ofemailstringrequired
groupsarray[string](uuid)required
Response
application/json
Response
application/json
Successfully created user(s)
One Ofidstring(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
post/tenants/users
Authentication
Body
{}
application/json