GET /role

Gets the permissions of a specific role.

Resource Name: /settings/permissions/role

Permissions Required:
  • administrator
Request URL Parameters:

Parameter

Type

Description
nameMandatory

String

Role name.
Return:

Parameter

Type

Description
name

String

Role name.
authorizedViewsAndActions

Array of NameAllowedPair (see NameAllowedPair )

View and action permissons.
authorizedApplications

Array of authorizedApplications (see authorizedApplications )

Permissions on applications.
roleUsers

Arrary of String

Associated usernames according to last login.
enabled

Boolean

Whether role is enabled: true or false.

Return Example: 

{
  "name": "DNS-role",
  "authorizedViewsAndActions": [
    {
      "name": "viewActivityLog",
      "allowed": false
    },
    {
      "name": "applyDrafts",
      "allowed": true
    },
...
  ],
  "authorizedApplications": [
    {
      "applicationID": 1,
      "name": "DNS",
      "permission": "view"
    },
    {
      "applicationID": 2,
      "name": "Backup",
      "permission": "edit"
    }
  ],
  "roleUsers": [
    "Sue","Joe"
  ],
  "enabled": true
}

 

â See also: