User
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's device type
User status
Sort by attribute
createdAtPossible values: Sort order
ascPossible values: List of user IDs to filter by
Filter users by portfolio membership
Successful response
Current page
Next page or null if there is none
Previous page or null if there is none
Max count of items per page
Total count of items
Invalid input data
Authorization not provided
Insufficient access
Not found
Internal server error
GET /rest/users HTTP/1.1
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",
"deviceType": "PSD",
"role": "ADMIN",
"pubKey": "text",
"status": "ACTIVE",
"isSuspended": true,
"createdAt": "text",
"updatedAt": "text"
}
]
}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
Successful response
User
Internal unique identifier
Legacy internal unique identifier (for retro-compatibility)
If true, user can read all resources on the workspace
User's workspace name
User name
User's device ID (for non-API users)
User's device type
User role
User public key
User status
Whether the user is suspended
Creation timestamp
Last modification timestamp
Invalid input data
Authorization not provided
Insufficient access
Not found
Internal server error
GET /rest/users/{id} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"id": "text",
"legacyId": 1,
"legacyViewAll": true,
"workspaceName": "text",
"name": "text",
"deviceUserId": "text",
"deviceType": "PSD",
"role": "ADMIN",
"pubKey": "text",
"status": "ACTIVE",
"isSuspended": true,
"createdAt": "text",
"updatedAt": "text"
}Reset the API user credentials. This will invalidate all existing API keys and generate a new one.
Id of the target user
Successful response
API key ID
API key secret
Invalid input data
Authorization not provided
Insufficient access
Internal server error
POST /rest/users/{id}/reset-api-credentials HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"apiKeyId": "text",
"apiKeySecret": "text"
}Return actions allowed to the user on one or more resources.
Id of the target user or me for the current user
meSuccessful response
User ID
Invalid input data
Authorization not provided
Insufficient access
Not found
Internal server error
GET /rest/permissions/allowed-actions HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"userId": "text",
"allowedActions": [
"READ"
]
}Return resources on which the user is allowed to perform the requested action.
Id of the target user or me for the current user
meAllowed action on the resource
Successful response
User ID
The requested action
Invalid input data
Authorization not provided
Insufficient access
Not found
Internal server error
GET /rest/permissions/resources?action=READ HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"userId": "text",
"action": "text",
"resources": [
{
"resourceType": "Account",
"resourceId": "text"
}
]
}Last updated