Search
K
Cipherscale API

Deactivate User Account

Temporarily disables a user account, preventing them from accessing the network while preserving their data and settings. Deactivated users can be reactivated later. This is useful for temporary suspensions or maintenance.

patch
https://public-api.cipherscale.com/qa/tenants/users/{id}/deactivate

Path Parameters

idstringrequired

Response

200 application/json

Successfully deactivated user account

User

Complete user profile with authentication, authorization, and device information

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

Reactivate User Account

Restores access for a previously deactivated user account. This operation re-enables all user permissions and allows them to reconnect their devices to the network.

post
https://public-api.cipherscale.com/qa/tenants/users/{id}/reactivate

Path Parameters

idstringrequired

Response

201 application/json

Successfully reactivated user account

User

Complete user profile with authentication, authorization, and device information

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

Resend User Invitation

Sends a new invitation email to a user with a pending invitation. This is useful when the original invitation email was not received, expired, or was accidentally deleted. Only users with pending invitation status can be reinvited.

post
https://public-api.cipherscale.com/qa/tenants/users/{id}/invite

Path Parameters

idstring(uuid)required

The unique identifier (UUID) of the user to reinvite

Response

Successfully sent invitation email to the user

post/tenants/users/{id}/invite
  
curl --request POST \
  --url https://public-api.cipherscale.com/qa/tenants/users//invite \
  --header 'Content-Type: application/json'
Successfully sent invitation email to the user

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

groupsOnlyboolean
rolesOnlyboolean

Path Parameters

idstringrequired

Response

200 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:OWNERADMINDEFAULTBASICBILLINGAUDITORSUPPORT

get/tenants/users/{id}/roles
  
curl --request GET \
  --url https://public-api.cipherscale.com/qa/tenants/users//roles \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json'
200 application/json
{
  "id": "id",
  "createdAt": "createdAt",
  "updatedAt": "updatedAt",
  "name": "name",
  "description": "description",
  "deleteable": false,
  "type": "OWNER"
}

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

UpdateUserRoles

Data for adding or removing roles from a user

addedRolesarray[string]required

Array of role IDs to add to the user

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

removedRolesarray[string]required

Array of role IDs to remove from the user

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

Response

200
patch/tenants/users/{id}/roles

Body

{
  "addedRoles": [
    "550e8400-e29b-41d4-a716-446655440000"
  ],
  "removedRoles": [
    "550e8400-e29b-41d4-a716-446655440001"
  ]
}
{ "addedRoles": [ "550e8400-e29b-41d4-a716-446655440000" ], "removedRoles": [ "550e8400-e29b-41d4-a716-446655440001" ] }
  
curl --request PATCH \
  --url https://public-api.cipherscale.com/qa/tenants/users//roles \
  --header 'Content-Type: application/json' \
  --data '{
  "addedRoles": [
    "550e8400-e29b-41d4-a716-446655440000"
  ],
  "removedRoles": [
    "550e8400-e29b-41d4-a716-446655440001"
  ]
}'
200