Skip to content

Roles

Roles Management

sys_administrator

List roles

HTTP
1
2
curl {{host}}/api/core/roles/browse \
-H "Authorization: Token {{token}}" \
Response
JSON
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
{
  "success": true,
  "message": "Role List",
  "requestID": "",
  "executed_at": "2050-01-01T00:00:00.123456Z",
  "data": {
    "items": [
      {
        "role_area": "app",
        "role_name": "app_administrator",
        "claim_created_by": "[email protected]",
        "claim_created_at": "2050-01-01T00:00:00",
        "username": "[email protected]",
        "user_count": "8"
      },
      {
        "role_area": "app",
        "role_name": "app_app-client",
        "claim_created_by": "[email protected]",
        "claim_created_at": "2050-01-01T00:00:00",
        "username": "[email protected]",
        "user_count": "5"
      }
    ]
  }
}

Role details

HTTP
1
2
curl {{host}}/api/core/roles/browse/{{role_name}} \
-H "Authorization: Token {{token}}" \
Response
JSON
1
2
3
4
5
6
7
8
9
{
  "success": true,
  "message": "Role list for account",
  "requestID": "",
  "executed_at": "2050-01-01T00:00:00.123456Z",
  "data": {
    "items": []
  }
}

Other Apis

HTTP
1
2
3
4
GET      {{host}}/api/core/roles/browse                                        //AUTH:sys_administrator
GET      {{host}}/api/core/roles/browse/{{role_name}}                          //AUTH:sys_administrator
POST     {{host}}/api/core/roles/user-remove/{{role_names}}/{{username}}       //AUTH:sys_administrator
POST     {{host}}/api/core/roles/user-assign/{{csv_roles}}/{{username}}        //AUTH:sys_administrator

Built in roles

Administrative roles

  • app_administrator
    • create/update/delete apps
    • create/delete connections
  • sys_administrator - Accounts, token,role,team management
  • sys_tokens - generate and browse API token for current account
  • srs_administrator - srs management visibility, for editing require app_[appname]_storage_write
  • sys_[connectionname]_query - run query against connections`

Application roles

  • app_[appname] - Application access
  • app_[appname]_read - read files
  • app_[appname]_write - write files
  • app_[appname]_scm - scm

Other

  • sys_comments - built in communication api
  • sys_subscribers - built in subscribers api for communication api