Search
K
Cipherscale API

UserGroup

object

User group information with role assignments and member management

idstring(uuid)required

Unique identifier for the user group

Example:550e8400-e29b-41d4-a716-446655440000

createdAtstring(date-time)required

Timestamp when the group was created

Example:2023-01-15T10:30:00Z

updatedAtstring(date-time)required

Timestamp when the group was last modified

Example:2023-01-15T10:30:00Z

namestringrequired

Human-readable name for the user group

Example:Engineering Team

descriptionstring

Detailed description of the group’s purpose and scope

Example:Software engineering team with access to development resources

Example

DeviceUser

object

User information associated with a device

idstring(uuid)required

Unique identifier for the user

Example:550e8400-e29b-41d4-a716-446655440000

lastConnectionstring(date-time)required

Timestamp of the user’s last network connection

Example:2023-01-15T14:30:00Z

emailstring

User’s email address

Example:john.doe@company.com

firstNamestring

User’s first name

Example:John

lastNamestring

User’s last name

Example:Doe

Example

Device

object

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

idstring(uuid)required

Unique identifier for the device

createdAtstring(date-time)required

Timestamp when the device was registered

updatedAtstring(date-time)required

Timestamp when the device information was last updated

namestringrequired

Human-readable name for the device

activebooleanrequired

Whether the device is currently active and can connect

lastConnectionstring(date-time)

Timestamp of the device’s last network connection

statusstringrequired

Current connection status of the device

Allowed values:OnlineOfflineDeactivated

userobject

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

Show Child Parameters
hardwareIdstringrequired

Unique hardware identifier for the device

postureobject

Security posture information and compliance status

appVersionstring

Version of the Cipherscale client application installed on the device

Example

User

object

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

maxDevicesnumberrequired

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
Example

CreateUser

object

Data required to create a new user account

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

Example