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
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
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
List All User Groups
Retrieves a paginated list of all user groups in the tenant, including their role assignments, member counts, and configuration settings.
get
https://public-api.cipherscale.com/qa/tenants/groups
Query Parameters
sortarray[string]
limitnumber
offsetnumber
Response
application/json
Response
application/json
Successfully retrieved groups
PaginatedResponse
Paginated response containing data and pagination metadata
dataarray
Array of items for the current page
totalinteger
Total number of items across all pages for the given filters. Use this with “limit” to compute total pages: totalPages = ceil(total / limit).
pageinteger
Current page index (0-based). For offset-based pagination, page = floor(offset / limit). For page[] style, this equals the N used in page[offset] = N × page[limit].
limitinteger
Number of items per page returned in this response. Mirrors the query “limit” or “page[limit]” parameter used for the request.
hasNextboolean
Whether there are more pages available
hasPreviousboolean
Whether there are previous pages available
get/tenants/groups
Authentication
Query Parameters
application/json
Update User Group
Modifies the configuration of an existing user group including its name, description, role assignments, and other settings.
put
https://public-api.cipherscale.com/qa/tenants/groups/{id}
Path Parameters
idstring(uuid)required
The unique identifier (UUID) of the group to update
Body
application/json
Body
application/json
UpdateGroup
Data for updating group configuration
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
200 application/json
Response
200 application/json
Successfully updated user 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"]
put/tenants/groups/{id}
Authentication
Path Parameters
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"
]
}
200 application/json