Roles
User role and permission management
List All Roles
Retrieves all user roles available in the tenant, including system-defined roles (OWNER, ADMIN, etc.) and custom roles with their permissions and capabilities.
get
https://public-api.cipherscale.com/qa/tenants/roles
Response
application/json
Response
application/json
Successfully retrieved roles
User role definition with specific permissions and capabilities
idstring(uuid)required
Unique identifier for the role
createdAtstring(date-time)required
Timestamp when the role was created
updatedAtstring(date-time)required
Timestamp when the role was last modified
namestringrequired
Human-readable name of the role
descriptionstring
Detailed description of the role’s purpose and permissions
deleteablebooleanrequired
Whether this role can be deleted (system roles are typically not deletable)
typestringrequired
Predefined role type that determines the base permissions
Allowed values:OWNERADMINDEFAULTBASICBILLINGAUDITOR
get/tenants/roles
Authentication
application/json
Get Role Details
Retrieves detailed information about a specific role including its permissions, type, and whether it can be deleted or modified.
get
https://public-api.cipherscale.com/qa/tenants/roles/{id}
Path Parameters
idstring(uuid)required
The unique identifier (UUID) of the role
Response
application/json
Response
application/json
Successfully retrieved the role
RoleDto
User role definition with specific permissions and capabilities
idstring(uuid)required
Unique identifier for the role
createdAtstring(date-time)required
Timestamp when the role was created
updatedAtstring(date-time)required
Timestamp when the role was last modified
namestringrequired
Human-readable name of the role
descriptionstring
Detailed description of the role’s purpose and permissions
deleteablebooleanrequired
Whether this role can be deleted (system roles are typically not deletable)
typestringrequired
Predefined role type that determines the base permissions
Allowed values:OWNERADMINDEFAULTBASICBILLINGAUDITOR
get/tenants/roles/{id}
Authentication
Path Parameters
application/json
Get Users with Role
Retrieves all users who have been assigned a specific role, including both direct assignments and users who inherit the role through group membership.
get
https://public-api.cipherscale.com/qa/tenants/roles/{id}/users
Query Parameters
groupsboolean
Whether to include users from groups that have this role
Path Parameters
idstring(uuid)required
The unique identifier (UUID) of the role
Response
application/json
Response
application/json
Successfully retrieved users assigned to the role
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/roles/{id}/users
Authentication
Path Parameters
Query Parameters
application/json
Remove User from Role
Removes a specific role assignment from a user, revoking the associated permissions. This operation affects the user’s access to system resources.
delete
https://public-api.cipherscale.com/qa/tenants/roles/{id}/users/{userId}
Path Parameters
idstring(uuid)required
The unique identifier (UUID) of the role
userIdstring(uuid)required
The unique identifier (UUID) of the user to remove from the role
Response
Response
Successfully removed user from role
delete/tenants/roles/{id}/users/{userId}