1. Home
  2. Integration & Setup
  3. Developer APIs
  4. Management of authorisati...
  5. Managing authorisation profiles

Managing authorisation profiles

The setup of the general route for the authorisation profiles is as follows:

https://ws.etracker.com/api/v6/subuserPublic/role

Query profile

You can set a GET request in order to query existing authorisation profiles in your account. The following Curl example is good for demonstration purposes here:

curl 'https://ws.etracker.com/api/v6/subuserPublic/role' -X GET -H 'X-ET-email: qa@etracker.com' -H 'X-ET-developerToken: ab7891ca89d9b4d10dc1703a7f0214256babe6c9' -H 'X-ET-accountId: 18854' -H 'X-ET-password: demo'

As a response to the GET request, you will then receive:

[[{"id":"7","name":"Read and write 
permissions","version":"1","users":"1"},{"id":"5","name":"Read 
permissions","version":"1","users":"2"}]]

Create profile

The following Curl example shows you how to create an authorisation profile that grants access to two sub-users:

curl 'https://ws.etracker.com/api/v6/subuserPublic/role' -X POST -H 'X-ET-email: qa@etracker.com' -H 'X-ET-developerToken: ab7891ca89d9b4d10dc1703a7f0214256babe6c9' -H 'X-ET-accountId: 18854' -H 'X-ET-password: demo' --data 'name=Test&role_type=admin&multi_client_access_mode=custom&multi_clients_selection%5B%5D=18855&multi_clients_selection%5B%5D=260960'

The information contained in the “–data” parameter is:

  • name = The name for the authorisation profile can be freely chosen and must be unique
  • role_type = Read and write permissions or just read permissions, value can be: read_only or admin
  • multi_client_access_mode = Set whether or not multiple clients can be accessed using this authorisation profile. Values can be: none, all or custom.
  • multi_clients_selection = Details of the multiple clients to whom access is granted. More than just one can be entered.

Important note: In the “–data” parameter, the following information must always be contained: name, role_type and multi_client_access_mode If the value “custom” is assigned to multi_client_access_mode, the corresponding accounts (multiple clients) must be set via multi_clients_selection (see Curl example).

If the value “custom” is assigned to multi_client_access_mode, the corresponding accounts (multiple clients) must be set via multi_clients_selection (see Curl example).

Delete profile

The setup of the route for deleting an authorisation profile is as follows:

https://ws.etracker.com/api/v6/subuserPublic/role/<roleId>

The following Curl shows a DELETE request, which deletes the profile with the ID 7.

curl 'https://ws.etracker.com/api/v6/subuserPublic/role/7' -X DELETE -H 'X-ET-email: qa@etracker.com' -H 'X-ET-developerToken: ab7891ca89d9b4d10dc1703a7f0214256babe6c9' -H 'X-ET-accountId: 18854' -H 'X-ET-password: demo'

Note: The available “roleIDs” can be queried with a GET request (see Curl example in “Query profile“). It will not be possible to delete an authorisation profile if it is also assigned to another user.