Cipherscale API

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

Get Device Details

Retrieves comprehensive information about a specific device including its configuration, connection status, associated user, hardware details, and security posture information.

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

Path Parameters

idstring(uuid)required

The unique identifier (UUID) of the device

Example:123e4567-e89b-12d3-a456-426614174000

Response

application/json

Successfully retrieved the device

DeviceDto

Device information including connection status, user association, and security posture

idstring(uuid)required

Unique identifier for the device

createdAtstring(date-time)required

Timestamp when the device was registered

updatedAtstring(date-time)required

Timestamp when the device information was last updated

namestringrequired

Human-readable name for the device

activebooleanrequired

Whether the device is currently active and can connect

lastConnectionstring(date-time)

Timestamp of the device’s last network connection

statusstringrequired

Current connection status of the device

Allowed values:OnlineOfflineDeactivated

userobject

Information about the user who owns this device

Show Child Parameters
hardwareIdstringrequired

Unique hardware identifier for the device

postureobject

Security posture information and compliance status

appVersionstring

Version of the Cipherscale client application installed on the device

get/tenants/devices/{id}
 
application/json

Remove Device

Permanently removes a device from the tenant. This operation will disconnect the device from the network and revoke all associated access permissions.

delete
https://public-api.cipherscale.com/qa/tenants/devices/{id}

Path Parameters

idstring(uuid)required

The unique identifier (UUID) of the device to delete

Response

Successfully deleted the device

delete/tenants/devices/{id}