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.
User data to create. Can be a single user object or an array of user objects (max 100).
One OfUser’s email address for authentication and notifications
Example:jane.smith@company.com
Array of group IDs to assign the user to
Example:["550e8400-e29b-41d4-a716-446655440000","550e8400-e29b-41d4-a716-446655440001"]
Successfully created user(s)
One OfUnique identifier for the user
Timestamp when the user account was created
Timestamp when the user account was last modified
Timestamp of the user’s last network connection
User’s email address used for authentication
Current status of the user account (active, inactive, pending, etc.)
User’s first name
User’s last name
Whether this user is the tenant owner
Maximum number of devices this user can register
URL or path to the user’s profile image
User role definition with specific permissions and capabilities
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"}
Device information including connection status, user association, and security posture
{}curl --request POST \
--url https://public-api.cipherscale.com/qa/tenants/users \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{}'{
"id": "id",
"createdAt": "createdAt",
"updatedAt": "updatedAt",
"lastConnection": "lastConnection",
"email": "email",
"status": "status",
"firstName": "firstName",
"lastName": "lastName",
"isOwner": false,
"maxDevices": 0,
"image": "image",
"roles": [
{
"id": "id",
"createdAt": "createdAt",
"updatedAt": "updatedAt",
"name": "name",
"description": "description",
"deleteable": false,
"type": "OWNER"
}
],
"groups": [
{
"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"
}
],
"devices": [
{
"id": "id",
"createdAt": "createdAt",
"updatedAt": "updatedAt",
"name": "name",
"active": false,
"lastConnection": "lastConnection",
"status": "Online",
"user": {
"id": "550e8400-e29b-41d4-a716-446655440000",
"email": "john.doe@company.com",
"firstName": "John",
"lastName": "Doe",
"lastConnection": "2023-01-15T14:30:00Z"
},
"hardwareId": "hardwareId",
"posture": {},
"appVersion": "appVersion"
}
]
}Device registration, management, and monitoring
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.
Number of items to return per page. Use with “offset” for pagination. If omitted, a default is applied. A maximum may be enforced by the server.
Number of items to skip before returning results. Use with “limit”. For page-based navigation: offset = page × limit.
Successfully retrieved devices
Paginated response containing data and pagination metadata
Array of items for the current page
Total number of items across all pages for the given filters. Use this with “limit” to compute total pages: totalPages = ceil(total / limit).
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].
Number of items per page returned in this response. Mirrors the query “limit” or “page[limit]” parameter used for the request.
Whether there are more pages available
Whether there are previous pages available
curl --request GET \
--url https://public-api.cipherscale.com/qa/tenants/devices \
--header 'Accept: application/json' \
--header 'Content-Type: application/json'{
"data": [
"[]"
],
"total": 0,
"page": 0,
"limit": 0,
"hasNext": false,
"hasPrevious": false
}Retrieves comprehensive information about a specific device including its configuration, connection status, associated user, hardware details, and security posture information.
The unique identifier (UUID) of the device
Example:123e4567-e89b-12d3-a456-426614174000
Successfully retrieved the device
Device information including connection status, user association, and security posture
Unique identifier for the device
Timestamp when the device was registered
Timestamp when the device information was last updated
Human-readable name for the device
Whether the device is currently active and can connect
Timestamp of the device’s last network connection
Current connection status of the device
Allowed values:OnlineOfflineDeactivated
Information about the user who owns this device
Example:{"id":"550e8400-e29b-41d4-a716-446655440000","email":"john.doe@company.com","firstName":"John","lastName":"Doe","lastConnection":"2023-01-15T14:30:00Z"}
Unique hardware identifier for the device
Security posture information and compliance status
Version of the Cipherscale client application installed on the device
curl --request GET \
--url https://public-api.cipherscale.com/qa/tenants/devices/123e4567-e89b-12d3-a456-426614174000 \
--header 'Accept: application/json' \
--header 'Content-Type: application/json'{
"id": "id",
"createdAt": "createdAt",
"updatedAt": "updatedAt",
"name": "name",
"active": false,
"lastConnection": "lastConnection",
"status": "Online",
"user": {
"id": "550e8400-e29b-41d4-a716-446655440000",
"email": "john.doe@company.com",
"firstName": "John",
"lastName": "Doe",
"lastConnection": "2023-01-15T14:30:00Z"
},
"hardwareId": "hardwareId",
"posture": {},
"appVersion": "appVersion"
}Permanently removes a device from the tenant. This operation will disconnect the device from the network and revoke all associated access permissions.
The unique identifier (UUID) of the device to delete
Successfully deleted the device
curl --request DELETE \
--url https://public-api.cipherscale.com/qa/tenants/devices/ \
--header 'Content-Type: application/json'Successfully deleted the device