Users

Authenticate

post

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
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
}

Refresh token

post

Exchange refreshToken for JWT tokens

Authorizations
Body
workspacestringRequired

Target workspace

refreshTokenstringRequired

Refresh token

Responses
200
Successful response
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

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
Query parameters
pageinteger · min: 1Optional

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:
Responses
200
Successful 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",
      "deviceType": "PSD",
      "role": "ADMIN",
      "pubKey": "text",
      "status": "ACTIVE",
      "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
Path parameters
idstringRequired

Id of the target user

Responses
200
Successful 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",
  "deviceType": "PSD",
  "role": "ADMIN",
  "pubKey": "text",
  "status": "ACTIVE",
  "createdAt": "text",
  "updatedAt": "text"
}
PreviousAPI referenceNextAccounts

Last updated