User
objectComplete user profile with authentication, authorization, and device information
Unique identifier for the user
Timestamp when the user account was created
Timestamp when the user account was last modified
Timestamp of the user’s last network connection
User’s email address used for authentication
Current status of the user account (active, inactive, pending, etc.)
User’s first name
User’s last name
Whether this user is the tenant owner
Maximum number of devices this user can register
URL or path to the user’s profile image
User role definition with specific permissions and capabilities
Show Child Parameters
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
Device information including connection status, user association, and security posture
Show Child Parameters
{
"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"
}
]
}CreateUser
objectData required to create a new user account
User’s email address for authentication and notifications
Example:jane.smith@company.com
Array of group IDs to assign the user to
Example:550e8400-e29b-41d4-a716-446655440000, 550e8400-e29b-41d4-a716-446655440001
{
"email": "jane.smith@company.com",
"groups": [
"550e8400-e29b-41d4-a716-446655440000",
"550e8400-e29b-41d4-a716-446655440001"
]
}PaginatedResponse
objectPaginated response containing data and pagination metadata
Array of items for the current page
Total number of items across all pages for the given filters. Use this with “limit” to compute total pages: totalPages = ceil(total / limit).
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].
Number of items per page returned in this response. Mirrors the query “limit” or “page[limit]” parameter used for the request.
Whether there are more pages available
Whether there are previous pages available
{
"data": [
"[]"
],
"total": 0,
"page": 0,
"limit": 0,
"hasNext": false,
"hasPrevious": false
}UpdateUser
objectData for updating user profile information
User’s first name
Example:Jane
User’s last name
Example:Smith
URL or path to the user’s profile image
Example:https://example.com/avatars/jane-smith.jpg
{
"firstName": "Jane",
"lastName": "Smith",
"image": "https://example.com/avatars/jane-smith.jpg"
}UpdateUserRoles
objectData for adding or removing roles from a user
Array of role IDs to add to the user
Example:550e8400-e29b-41d4-a716-446655440000
Array of role IDs to remove from the user
Example:550e8400-e29b-41d4-a716-446655440001
{
"addedRoles": [
"550e8400-e29b-41d4-a716-446655440000"
],
"removedRoles": [
"550e8400-e29b-41d4-a716-446655440001"
]
}