idstring(uuid)required
The unique identifier (UUID) of the user to delete
Delete User Account
Permanently removes a user account from the tenant. This operation will also deactivate all associated devices and revoke all access permissions. This action cannot be undone.
delete
https://public-api.cipherscale.com/qa/tenants/users/{id}
Path Parameters
Response
Response
Successfully deleted the user
delete/tenants/users/{id}
Authentication
Path Parameters
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
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
Authentication
Path Parameters
200 application/json
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
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
Authentication
Path Parameters
201 application/json
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
Response
Successfully sent invitation email to the user
post/tenants/users/{id}/invite
Authentication
Path Parameters
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
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
Authentication
Path Parameters
Query Parameters
200 application/json