User Management

Get User Groups

GET https://[customer].testresults.io/api/management/customers/current

Gets User Groups.

Headers

Name	Type	Description
Authentication	string	Authentication token

200 Cake successfully retrieved.

{
  "UserGroups": [
    {
      "Name": "Administrators",
      "Description": "Admin Group for Test & Demo",
      "UsagePermission": "Login, Read, Write, Execute, Accept, Reject, UserSettings, UserManagement, Automation, ClaimManagement, CustomerManagement, AccessSecrets, Invoicing, ExecutionTimes",
      "DataVersion": null,
      "Archived": false,
      "Id": "34815f3d-cf2f-4653-8677-1d3ebc51e2ef"
    },
    {
      "Name": "Automation Engineer",
      "Description": "TestResults.io Automation Engineer",
      "UsagePermission": "Login, Read, Write, Execute, Accept, Reject, UserSettings, Automation",
      "DataVersion": null,
      "Archived": false,
      "Id": "f7eef9b7-1508-44b3-9d97-85d33f86e341"
    }
  ],
  "Name": "Test & Demo GmbH",
  "AccountNumber": "INT-PRG-01",
  "Address": "progile GmbH;Riedwiesenstr. 23;8305 Dietlikon;Schweiz",
  "CostCenter": "TRIO-RUN",
  "Currency": "CHF",
  "Tax": 770,
  "Discounts": null,
  "MinimumConsumptionInH": 40,
  "DueDays": 90,
  "TechnicalName": "testanddemo",
  "Subdomain": "stage",
  "Appliances": "Development (Oleg):oleglocal,Dummy:dummyProbe,Stage Box:b8aeed7fa02a",
  "DataVersion": "AAAAAAAq+HI=",
  "Archived": false,
  "Id": "00000000-0000-0000-0000-000000000010"
}

Create new User Group

POST https://[customer].testresults.io/api/management/customers/current/groups

Creates new User Group.

Headers

Name	Type	Description
Authentication	string	Authentication token

Request Body

Name	Type	Description
Name	string	Group Name
Description	string	Group Description
UsagePermission	string	List of permissions (at least one), comma separated(e.g "Login, Read, Write"...etc)

200

{
  "Name": "test group2",
  "Description": null,
  "UsagePermission": "Login, Read, Write",
  "DataVersion": "AAAAAAAzlGM=",
  "Archived": false,
  "Id": "1413fed0-4b1a-4b74-a6dd-bf6b86225a1d"
}

Update User Group

PUT https://[customer].testresults.io/api/management/customers/current/groups/:gId

Updates an existing User Group.

Path Parameters

Name	Type	Description
gId	string	Group ID

Headers

Name	Type	Description
Authentication	string	Authentication token

Request Body

Name	Type	Description
Name	string	Group Name
Description	string	Group Description
UsagePermission	string	List of permissions, comma separated (e.g "Login, Read, Write"...etc)

200

{
  "Name": "Test Group",
  "Description": "andriy's group2",
  "UsagePermission": "Login, Read, Write, UserSettings, UserManagement, CustomerManagement",
  "DataVersion": "AAAAAAAzlGA=",
  "Archived": false,
  "Id": "b24f80f5-3e1c-4e3a-ae12-ce8eda3f4603"
}

Delete User Group

DELETE https://[customer].testresults.io/api/management/customers/current/groups/:gId

Deletes User Group.

Path Parameters

Name	Type	Description
gId	string	Group ID

Headers

Name	Type	Description
Authentication	string	Authentication token

200

Get Users

GET https://[customer].testresults.io/api/management/customers/current/groups/:gId/users

Gets all Users for the selected Group.

Path Parameters

Name	Type	Description
gId	string	Group ID

200

[
  {
    "Email": "[e-mail]",
    "UsagePermission": "Login, Read, Write, Execute, Accept, Reject, UserSettings, Automation",
    "Features": null,
    "DisplayName": "Rudi",
    "Password": null,
    "PreviousLogin": null,
    "LastLogin": "2018-08-02T14:06:39.4033333Z",
    "Profile": null,
    "UserGroup": null,
    "DataVersion": "AAAAAAAfaSY=",
    "Archived": false,
    "Id": "eec02495-a1ac-46b1-95ec-07e20096cb7b"
  },
  {
    "Email": "[e-mail]",
    "UsagePermission": "Login, Read, Write, Execute, Accept, Reject, UserSettings, Automation",
    "Features": null,
    "DisplayName": "Tobias Röthlin",
    "Password": null,
    "PreviousLogin": "2019-05-02T09:00:41.1766667Z",
    "LastLogin": "2019-05-02T09:00:41.2433333Z",
    "Profile": null,
    "UserGroup": null,
    "DataVersion": "AAAAAAAzh38=",
    "Archived": false,
    "Id": "c83f7ba9-e0bb-4180-b00d-226f2db5f1ee"
  }
]

Create new User

POST https://[customer].testresults.io/api/users

Creates new User.

Headers

Name	Type	Description
Authentication	string	Authentication token

Request Body

Name	Type	Description
DisplayName	string	User Display Name
Email	string	User Email
UserGroup	object	User Group
Id	string	User Group ID. The field of UserGroup object (e.g UsserGroup: { Id: { user_group_ID } })

200

{
  "Email": "[e-mail]",
  "UsagePermission": "Login, Read, Write, UserSettings, UserManagement, CustomerManagement",
  "Features": null,
  "DisplayName": "andriy2",
  "Password": null,
  "PreviousLogin": "2019-03-14T11:17:28.6966667Z",
  "LastLogin": "2019-03-14T18:43:40.6333333Z",
  "Profile": null,
  "UserGroup": {
    "Name": "Test Group",
    "Description": "andriy's group2",
    "UsagePermission": "Login, Read, Write, UserSettings, UserManagement, CustomerManagement",
    "DataVersion": "AAAAAAAzlGA=",
    "Archived": false,
    "Id": "b24f80f5-3e1c-4e3a-ae12-ce8eda3f4603"
  },
  "DataVersion": "AAAAAAAzl1s=",
  "Archived": false,
  "Id": "1dbc8860-6b94-4ba0-8161-00d5262f61c3"
}

Update User

PUT https://[customer].testresults.io/api/users/:uId

Updates an existing User.

Path Parameters

Name	Type	Description
uId	string	User ID

Headers

Name	Type	Description
Authentication	string	Authentication token

Request Body

Name	Type	Description
UserData	object	User Data container. (!) All subsequent fields are fields of UserData object. The request payload example: { UserData: { DisplayName: 'user_display_name', Email: 'user_email', UserGroup: { Id: 'user_group_ID' } } }
DisplayName	string	User Display Name. The field of UserData object (e.g UserData: { DisplayName: user_display_name })
Email	string	User Email. The field of UserData object (e.g UserData: { Email: user_email })
UserGroup	object	User Group. The field of UserData object (e.g UserData: { UserGroup: { ... } })
Id	string	User Group ID. The field of UserGroup object (e.g UserGroup: { Id: user_group_ID })

200

{
  "Email": "[e-mail]",
  "UsagePermission": "Login, Read, Write, UserSettings, UserManagement, CustomerManagement",
  "Features": null,
  "DisplayName": "andriy2",
  "Password": null,
  "PreviousLogin": "2019-03-14T11:17:28.6966667Z",
  "LastLogin": "2019-03-14T18:43:40.6333333Z",
  "Profile": null,
  "UserGroup": {
    "Name": "Test Group",
    "Description": "andriy's group2",
    "UsagePermission": "Login, Read, Write, UserSettings, UserManagement, CustomerManagement",
    "DataVersion": "AAAAAAAzlGA=",
    "Archived": false,
    "Id": "b24f80f5-3e1c-4e3a-ae12-ce8eda3f4603"
  },
  "DataVersion": "AAAAAAAzl1s=",
  "Archived": false,
  "Id": "1dbc8860-6b94-4ba0-8161-00d5262f61c3"
}

Delete User

DELETE https://[customer].testresults.io/api/users/:uId

Delete User.

Path Parameters

Name	Type	Description
uId	string	User ID

Headers

Name	Type	Description
Authentication	string	Authentication token

200