Users
Last updated
Last updated
List users in the same workspace. Administrators & operators with legacyViewAll set to true can see the full list, other users can only see themselves.
Which page to fetch
1Page size to use
30User role
User status
Sort by attribute
createdAtPossible values: Sort order
ascPossible values: GET /rest/users HTTP/1.1
Host:
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"page": 1,
"next": 1,
"prev": 1,
"pageSize": 1,
"total": 1,
"results": [
{
"id": "text",
"legacyId": 1,
"legacyViewAll": true,
"workspaceName": "text",
"name": "text",
"deviceUserId": "text",
"role": "ADMIN",
"status": "ACTIVE",
"createdAt": "2025-06-20T17:18:28.784Z",
"updatedAt": "2025-06-20T17:18:28.784Z"
}
]
}Find a user by its ID. Use me to fetch current user. Operators can only see themselves (unless they have legacyViewAll set to true), fetching other users will yield Not Found error.
Id of the target user
GET /rest/users/{id} HTTP/1.1
Host:
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"id": "text",
"legacyId": 1,
"legacyViewAll": true,
"workspaceName": "text",
"name": "text",
"deviceUserId": "text",
"role": "ADMIN",
"status": "ACTIVE",
"createdAt": "2025-06-20T17:18:28.784Z",
"updatedAt": "2025-06-20T17:18:28.784Z"
}Exchange API Key credentials for JWT tokens
Target workspace
API Key id
API Key secret
POST /rest/auth/token HTTP/1.1
Host:
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 60
{
"workspace": "text",
"apiKeyId": "text",
"apiKeySecret": "text"
}{
"accessToken": "text",
"expiresInSeconds": 1,
"refreshToken": "text",
"refreshExpiresInSeconds": 1
}Exchange refreshToken for JWT tokens
Target workspace
Refresh token
POST /rest/auth/token/refresh HTTP/1.1
Host:
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 42
{
"workspace": "text",
"refreshToken": "text"
}{
"accessToken": "text",
"expiresInSeconds": 1,
"refreshToken": "text",
"refreshExpiresInSeconds": 1
}