Users
Exchange API Key credentials for JWT tokens
Authorizations
Body
workspacestringRequired
Target workspace
apiKeyIdstringRequired
API Key id
apiKeySecretstringRequired
API Key secret
Responses
200
Successful response
application/json
400
Invalid input data
application/json
401
Authorization not provided
application/json
403
Insufficient access
application/json
500
Internal server error
application/json
post
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
Authorizations
Body
workspacestringRequired
Target workspace
refreshTokenstringRequired
Refresh token
Responses
200
Successful response
application/json
400
Invalid input data
application/json
401
Authorization not provided
application/json
403
Insufficient access
application/json
500
Internal server error
application/json
post
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
}
List users in the same workspace. Administrators & operators with legacyViewAll
set to true
can see the full list, other users can only see themselves.
Authorizations
Query parameters
pageany ofOptionalDefault:
Which page to fetch
1
notOptional
integer · min: 1Optional
pageSizeany ofOptionalDefault:
Page size to use
30
notOptional
integer · min: 1 · max: 30Optional
rolestring · enumOptionalPossible values:
User role
statusstring · enumOptionalPossible values:
User status
sortBystring · enumOptionalDefault:
Sort by attribute
createdAt
Possible values: sortOrderstring · enumOptionalDefault:
Sort order
asc
Possible values: Responses
200
Successful response
application/json
default
Error response
application/json
get
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-22T14:25:44.186Z",
"updatedAt": "2025-06-22T14:25:44.186Z"
}
]
}
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.
Authorizations
Path parameters
idstringRequired
Id of the target user
Responses
200
Successful response
application/json
default
Error response
application/json
get
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-22T14:25:44.186Z",
"updatedAt": "2025-06-22T14:25:44.186Z"
}
Last updated