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

204
delete/tenants/users/{id}/groups/{groupId}
  
curl --request DELETE \
  --url https://public-api.cipherscale.com/qa/tenants/users//groups/ \
  --header 'Content-Type: application/json' \
  --header 'apikey: '
204

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

Number of items to return per page. Use together with “offset” for pagination. If omitted, a sensible default is applied (e.g., 10). Upper bound may be enforced by the server (e.g., 100).

offsetnumber

Number of items to skip before starting to collect results. Use together with “limit”. For page-based navigation, compute as (page × limit). Example: page=2 with limit=25 -> offset=50.

Response

application/json

Successfully retrieved users

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/users
  
curl --request GET \
  --url https://public-api.cipherscale.com/qa/tenants/users \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --header 'apikey: '
application/json
{
  "data": [
    "[]"
  ],
  "total": 0,
  "page": 0,
  "limit": 0,
  "hasNext": false,
  "hasPrevious": false
}

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

User’s email address for authentication and notifications

Example:jane.smith@company.com

groupsarray[string](uuid)required

Array of group IDs to assign the user to

Example:["550e8400-e29b-41d4-a716-446655440000","550e8400-e29b-41d4-a716-446655440001"]

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

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"}

Show Child Parameters
devicesarray[object]required

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

Show Child Parameters
post/tenants/users

Body

{}
{}
  
curl --request POST \
  --url https://public-api.cipherscale.com/qa/tenants/users \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --header 'apikey: ' \
  --data '{}'
application/json
{
  "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"
    }
  ]
}

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

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.

offsetnumber

Number of items to skip before returning results. Use with “limit”. For page-based navigation: offset = page × limit.

Response

application/json

Successfully retrieved devices

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/devices
  
curl --request GET \
  --url https://public-api.cipherscale.com/qa/tenants/devices \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --header 'apikey: '
application/json
{
  "data": [
    "[]"
  ],
  "total": 0,
  "page": 0,
  "limit": 0,
  "hasNext": false,
  "hasPrevious": false
}