API for Administration
- 1 Create User and Map Roles
- 2 Update Role/Project for User
- 3 Generate/Reset Automation API Key
- 4 Get List of Users
- 5 Deactivate User
- 6 Delete User
- 7 Get List of Roles
- 8 Get List of Execution Statuses
- 9 Get Automation Progress Status
- 10 Get List of fields
- 11 Get List of Custom Lists and Dropdowns
- 12 Get List of Custom List Values
- 13 Add Custom List
- 14 Add/Update Custom List
- 15 Delete Custom List
- 16 Get List of Audit Logs
- 17 Add BDD Configuration
- 18 List BDD Repositories
- 19 Test BDD Credentials
- 20 Update BDD Configuration
- 21 Delete BDD Configuration
- 22 Get List of Label Values
- 23 Add/Update Label List
- 24 API to execute batch requests
- 25 Definitions
POST /rest/admin/user/withrole
Request
Content-Type: application/json
Parameters
Response
Content-Type: application/json
Status Code | Reason | Response Model |
|---|---|---|
200 | User created successfully | |
400 | Invalid json object or mandatory fields missing | - |
401 | Unauthorised or session expired | - |
500 | Returned when server connection times out | - |
PUT /rest/admin/user/update/withrole
Request
Content-Type: application/json
Parameters
Name | Located in | Required | Description | Default | Schema |
|---|---|---|---|---|---|
body | body | no | - | string | |
user | body | yes | Object of user to be updated | - | |
maprole | body | yes | Object of maprole having details of project roles to be assigned while updating user | - |
Response
Content-Type: application/json
Status Code | Reason | Response Model |
|---|---|---|
200 | User created successfully | |
400 | Invalid json object or mandatory fields missing | - |
401 | Unauthorised or session expired | - |
500 | Returned when server connection times out | - |
POST /rest/admin/user/generateAutomationAPIKey
Request
Content-Type: application/json
Parameters
Name | Located in | Required | Description | Default | Schema |
|---|---|---|---|---|---|
Content-Type | header | yes | application/json | - | string |
apikey | header | yes | Open API key | - | string |
scope | header | yes | default | - | string |
Response
Content-Type: application/json
Status Code | Reason | Response Model |
|---|---|---|
200 | Successful operation. | |
500 | Returned if there is an error in server | - |
POST /rest/admin/user/list
Request
Content-Type: application/json
Parameters
Name | Located in | Required | Description | Default | Schema |
|---|---|---|---|---|---|
start | body | no | provide start | - | integer |
limit | body | no | provide limit | - | integer |
page | body | no | provide page | - | integer |