idstring(uuid)required
The unique identifier (UUID) of the role
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
Response
application/json
Response
application/json
Successfully retrieved the role
Role
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:OWNERADMINDEFAULTBASICBILLINGAUDITORSUPPORT
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
User group information with role assignments and member management
Example:{"id":"550e8400-e29b-41d4-a716-446655440000","name":"Engineering Team","description":"Software engineering team with access to development resources","createdAt":"2023-01-15T10:30:00Z","updatedAt":"2023-01-15T10:30:00Z"}
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}
Authentication
Path Parameters
Groups
User group management and role assignments
Create User Group
Creates a new user group with assigned roles and permissions. Groups provide a way to manage multiple users with similar access requirements efficiently.
post
https://public-api.cipherscale.com/qa/tenants/groups
Body
application/json
Body
application/json
The group data to create
CreateGroup
Data required to create a new user group
rolesarray[string]required
Array of role IDs to assign to the group
Example:["550e8400-e29b-41d4-a716-446655440000","550e8400-e29b-41d4-a716-446655440001"]
namestringrequired
Human-readable name for the group
Example:Marketing Team
descriptionstring
Detailed description of the group’s purpose and scope
Example:Marketing team with access to customer data and analytics tools
Response
application/json
Response
application/json
Successfully created the group
Group
Complete user group information with members, roles, and configuration
idstring(uuid)required
Unique identifier for the group
Example:550e8400-e29b-41d4-a716-446655440000
createdAtstring(date-time)required
Timestamp when the group was created
Example:2023-01-15T10:30:00Z
updatedAtstring(date-time)required
Timestamp when the group was last modified
Example:2023-01-15T10:30:00Z
namestringrequired
Human-readable name for the group
Example:Engineering Team
descriptionstring
Detailed description of the group’s purpose and scope
Example:Software engineering team with access to development resources
rolesarray[object]required
User role definition with specific permissions and capabilities
Show Child Parameters
deleteablebooleanrequired
Whether this group can be deleted
Example:true
usersarray[object]required
User information within a group context
Example:{"id":"550e8400-e29b-41d4-a716-446655440000","firstName":"John","lastName":"Doe","email":"john.doe@company.com","createdAt":"2023-01-15T10:30:00Z","updatedAt":"2023-01-15T10:30:00Z"}
Show Child Parameters
maxDevicesnumberrequired
Maximum number of devices per user in this group
Example:5
isSamlDefaultGroupbooleanrequired
Whether this is the default group for SAML users
Example:false
idpMappingarray[string]required
Identity provider mapping for this group
Example:["engineering@company.com"]
post/tenants/groups
Authentication
Body
{
"name": "Marketing Team",
"description": "Marketing team with access to customer data and analytics tools",
"roles": [
"550e8400-e29b-41d4-a716-446655440000",
"550e8400-e29b-41d4-a716-446655440001"
]
}
application/json