idstring(uuid)required
The unique identifier (UUID) of the protocol
Get Protocol Details
Retrieves detailed information about a specific network protocol including its name, type, and associated network protocol settings (TCP, UDP, ICMP).
get
https://public-api.cipherscale.com/qa/tenants/protocols/{id}
Path Parameters
Response
application/json
Response
application/json
Successfully retrieved the protocol
Protocol
idstring(uuid)required
Unique identifier for the protocol
Example:550e8400-e29b-41d4-a716-446655440000
namestringrequired
Human-readable name for the protocol
Example:HTTP/HTTPS
networkProtocolsarray[object]required
Array of network protocol configurations
Example:{"protocol":"TCP","port":"80"}
Show Child Parameters
typestringrequired
Protocol type classification
Allowed values:ALLPREDEFINEDCUSTOM
Example:PREDEFINED
get/tenants/protocols/{id}
Authentication
Path Parameters
application/json
Roles
User role and permission management
List All Roles
Retrieves all user roles available in the tenant, including system-defined roles (OWNER, ADMIN, etc.) and custom roles with their permissions and capabilities.
get
https://public-api.cipherscale.com/qa/tenants/roles
Response
application/json
Response
application/json
Successfully retrieved roles
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/roles
Authentication
application/json
Get Role Details
Retrieves detailed information about a specific role including its permissions, type, and whether it can be deleted or modified.
get
https://public-api.cipherscale.com/qa/tenants/roles/{id}
Path Parameters
idstring(uuid)required
The unique identifier (UUID) of the role
Response
application/json
Response
application/json
Successfully retrieved the role
Role
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/roles/{id}
Authentication
Path Parameters
application/json
Get Users with Role
Retrieves all users who have been assigned a specific role, including both direct assignments and users who inherit the role through group membership.
get
https://public-api.cipherscale.com/qa/tenants/roles/{id}/users
Query Parameters
groupsboolean
Whether to include users from groups that have this role
Path Parameters
idstring(uuid)required
The unique identifier (UUID) of the role
Response
application/json
Response
application/json
Successfully retrieved users assigned to the role
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
get/tenants/roles/{id}/users
Authentication
Path Parameters
Query Parameters
application/json