Users

All

API endpoint: /api/v1/users
Type: GET
Description: Returns application’s users
Parameters: none
Result

[
  {
    "id": 123,
    "username": "John",
    "admin": false,
    "role": [
      "analyst"
    ],
    "privileges": [
      "allowToExecute"
    ],
    "lastActive": "2023-06-22 10:02:35"
  }
]

Add

API endpoint: /api/v1/users/add
Type: POST
Description: Add user
Parameters: user details
Example body:

{
  "userName": "David",
  "displayName": "David Rockstone",
  "password": "secretPassword",
  "roles": [
    "analyst"
  ]
}

Result

{
  "id": 13,
  "username": "David",
  "admin": false,
  "role": [
    "analyst"
  ],
  "privileges": [
    "allowToExecute"
  ],
  "lastActive": null
}

Delete

API endpoint: /api/v1/users/delete
Type: POST
Description: Delete user
Parameters: user details
Example body:

{
  "userName": "David"
}

Result: none

Roles

API endpoint: /api/v1/users/roles
Type: GET
Description: Get all available user roles
Parameters: user details
Result

[
  {
    "roleId": 14,
    "roleName": "Rest Analyst",
    "allowedConnections": [
      "Live DWH"
    ],
    "privileges": [
      "addEditTestsuites",
      "addEditTestCases"
    ]
  },
  {
    "roleId": 20,
    "roleName": "executor",
    "allowedConnections": [
      "Crypto",
      "Live DWH"
    ],
    "privileges": [
      "allowToExecute",
      "addEditTestCases"
    ]
  }
]

Assign roles

API endpoint: /api/v1/users/roles/assign
Type: POST
Description: Assign role(s) to user
Parameters: user details
Example body:

{
  "userName": "David",
  "roles": [
    "user",
    "exporter"
  ]
}

Result

{
  "id": 49,
  "username": "David",
  "admin": false,
  "role": [
    "user",
    "exporter"
  ],
  "privileges": [
    "addEditConnections",
    "addEditDirectories",
    "addEditProfilingObjects",
    "addEditProfilingRules",
    "addEditRules",
    "addEditTestCases",
    "addEditTestsuites",
    "allowExport",
    "allowToExecute"
  ],
  "lastActive": "2023-06-21 11:19:09"
}

Last modified: 22 July 2024