Search
K
Cipherscale API

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

delete/tenants/users/{id}/groups/{groupId}
 

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

Successfully retrieved users

PaginatedDto

PaginatedDtoobject
get/tenants/users
 
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

User data to create. Can be a single user object or an array of user objects (max 100).

One Of
emailstringrequired
groupsarray[string](uuid)required

Response

application/json

Successfully created user(s)

One Of
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
post/tenants/users

Body

{}
 
application/json

Devices

Device registration, management, and monitoring

List All Devices

Retrieves a paginated list of all devices registered to the tenant with support for filtering, sorting, and search. This endpoint provides comprehensive device information including connection status, user associations, and hardware details.

get
https://public-api.cipherscale.com/qa/tenants/devices

Query Parameters

sortarray[string]
limitnumber
offsetnumber

Response

application/json

Successfully retrieved devices

PaginatedDto

PaginatedDtoobject
get/tenants/devices
 
application/json