groupsOnlyboolean
rolesOnlyboolean
Get User Role Assignments
Retrieves all roles currently assigned to a specific user, including both direct role assignments and roles inherited through group memberships. This information is crucial for understanding user permissions and access levels.
get
https://public-api.cipherscale.com/qa/tenants/users/{id}/roles
Query Parameters
Path Parameters
idstringrequired
Response
application/json
Response
application/json
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/users/{id}/roles
Authentication
Path Parameters
Query Parameters
application/json
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
idstringrequired
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