User

List users

get

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

Authorization

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

pageinteger · min: 1 · max: 9007199254740991Optional

Which page to fetch

Default: 1

pageSizeinteger · min: 1 · max: 30Optional

Page size to use

Default: 30

rolestring · enumOptional

User role

Possible values:

deviceTypestring · enumOptional

User's device type

Possible values:

statusstring · enumOptional

User status

Possible values:

sortBystring · enumOptional

Sort by attribute

Default: createdAtPossible values:

sortOrderstring · enumOptional

Sort order

Default: ascPossible values:

idsstring[]Optional

List of user IDs to filter by

Responses

200

Successful response

application/json

pagenumberRequired

Current page

nextany ofRequired

Next page or null if there is none

numberOptional

or

nullOptional

prevany ofRequired

Previous page or null if there is none

numberOptional

or

nullOptional

pageSizenumberRequired

Max count of items per page

totalnumberRequired

Total count of items

400

Invalid input data

application/json

401

Authorization not provided

application/json

403

Insufficient access

application/json

404

Not found

application/json

500

Internal server error

application/json

get

/users

HTTPcURLJavaScriptPython

GET /v1/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"
    }
  ]
}

Get a single user

get

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

Authorization

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequired

Id of the target user

Responses

200

Successful response

application/json

idstringRequired

Internal unique identifier

legacyIdnumberRequired

Legacy internal unique identifier (for retro-compatibility)

legacyViewAllbooleanRequired

If true, user can read all resources on the workspace

workspaceNamestringRequired

User's workspace name

namestringRequired

User name

deviceUserIdany ofRequired

User's device ID (for non-API users)

stringOptional

or

nullOptional

deviceTypestring · enumRequired

User's device type

Possible values:

rolestring · enumRequired

User role

Possible values:

pubKeystringRequired

User public key

statusstring · enumRequired

User status

Possible values:

isSuspendedbooleanRequired

Whether the user is suspended

createdAtstringRequired

Creation timestamp

updatedAtstringRequired

Last modification timestamp

400

Invalid input data

application/json

401

Authorization not provided

application/json

403

Insufficient access

application/json

404

Not found

application/json

500

Internal server error

application/json

get

/users/{id}

HTTPcURLJavaScriptPython

GET /v1/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 API user credentials

post

Reset the API user credentials. This will invalidate all existing API keys and generate a new one.

Authorizations

Authorization

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequired

Id of the target user

Responses

200

Successful response

application/json

apiKeyIdstringRequired

API key ID

apiKeySecretstringRequired

API key secret

400

Invalid input data

application/json

401

Authorization not provided

application/json

403

Insufficient access

application/json

500

Internal server error

application/json

post

/users/{id}/reset-api-credentials

HTTPcURLJavaScriptPython

POST /v1/rest/users/{id}/reset-api-credentials HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "apiKeyId": "text",
  "apiKeySecret": "text"
}

Get allowed actions

get

Return actions allowed to the user on one or more resources.

Authorizations

Authorization

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

userIdstringOptional

Id of the target user or me for the current user

Default: me

resourceTypestring · enumOptionalPossible values:

resourceIdstringOptional

Responses

200

Successful response

application/json

userIdstringRequired

User ID

400

Invalid input data

application/json

401

Authorization not provided

application/json

403

Insufficient access

application/json

404

Not found

application/json

500

Internal server error

application/json

get

/permissions/allowed-actions

HTTPcURLJavaScriptPython

GET /v1/rest/permissions/allowed-actions HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "userId": "text",
  "allowedActions": [
    "READ"
  ]
}

Find allowed resources

get

Return resources on which the user is allowed to perform the requested action.

Authorizations

Authorization

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

userIdstringOptional

Id of the target user or me for the current user

Default: me

resourceTypestring · enumOptionalPossible values:

actionstring · enumRequired

Allowed action on the resource

Possible values:

Responses

200

Successful response

application/json

userIdstringRequired

User ID

actionstringRequired

The requested action

400

Invalid input data

application/json

401

Authorization not provided

application/json

403

Insufficient access

application/json

404

Not found

application/json

500

Internal server error

application/json

get

/permissions/resources

HTTPcURLJavaScriptPython

GET /v1/rest/permissions/resources?action=READ HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "userId": "text",
  "action": "text",
  "resources": [
    {
      "resourceType": "Account",
      "resourceId": "text"
    }
  ]
}