Get all feature permissions

The GET /accessPermissions endpoint gets a list of all feature permissions for features available in your account.

In this page

Headers

Header parameters in Requests (User Admin API) apply to this endpoint.

Authorization scopes supported:

Scope	Access granted
`users:read`	Entire endpoint
`users:write`	Entire endpoint

Parameters

The endpoint accepts the following query parameters:

`limit`

Type	Required	Example
integer	False	`25`

The required number of items per page. Minimum of 1. Maximum of 5000. Default is 25.

`page`

Type	Required	Example
integer	False	`1`

The required page. Minimum of 1, maximum of 1000000000. Default is 1.

Requests

Request all feature permissions

curl -L -X GET "https://***.api.newvoicemedia.com/useradmin/accessPermissions" \
-H "Accept: application/vnd.newvoicemedia.v4+json" \
-H "Authorization: Bearer <ACCESS_TOKEN>"

Request second page of feature permissions

curl -L -X GET "https://***.api.newvoicemedia.com/useradmin/accessPermissions?page=2" \
-H "Accept: application/vnd.newvoicemedia.v4+json" \
-H "Authorization: Bearer <ACCESS_TOKEN>"

Responses

Responses contain a list of all feature permissions.

Successful response

Successful requests return a 200 Success code and a collection of feature permissions.

Example response

{
  "meta": {
    "page": 1,
    "count": 2,
    "pageCount": 1,
    "totalCount": 2
  },
  "accessPermissions": [     {
      "permissionKey": "CPA_View",
      "permissionName": "Access Interaction Plans Architect",
      "permissionCategory": "Interaction Plans",
      "permissionSubCategory": "",
      "permissionLevels": [
        "No",
        "Yes"
      ],
      "selectableLevels": [
        "No",
        "Yes"
      ],
      "rolePermissionLevels": {
        "superUser": {
          "defaultValue": "Yes",
          "values": [
            "No",
            "Yes"
          ]
        },
        "agent": {
          "defaultValue": "Yes",
          "values": [
            "No",
            "Yes"
          ]
        },
        "reseller": {
          "defaultValue": "Yes",
          "values": [
            "No",
            "Yes"
          ]
        },
        "admin": {
          "defaultValue": "Yes",
          "values": [
            "No",
            "Yes"
          ]
        },
        "supervisor": {
          "defaultValue": "No",
          "values": [
            "No",
            "Yes"
          ]
        },
        "wallboard": {
          "defaultValue": "No",
          "values": [
            "No"
          ]
        }
      }
    },
    {
      "permissionKey": "CPA_ACD",
      "permissionName": "ACD",
      "permissionCategory": "Interaction Plans",
      "permissionSubCategory": "Applets",
      "permissionLevels": [
        "No",
        "Read",
        "Modify"
      ],
      "selectableLevels": [
        "No",
        "Read",
        "Modify"
      ],
      "rolePermissionLevels": {
        "superUser": {
          "defaultValue": "Modify",
          "values": [
            "No",
            "Read",
            "Modify"
          ]
        },
        "agent": {
          "defaultValue": "Modify",
          "values": [
            "No",
            "Read",
            "Modify"
          ]
        },
        "reseller": {
          "defaultValue": "Modify",
          "values": [
            "No",
            "Read",
            "Modify"
          ]
        },
        "admin": {
          "defaultValue": "Modify",
          "values": [
            "No",
            "Read",
            "Modify"
          ]
        },
        "supervisor": {
          "defaultValue": "Read",
          "values": [
            "No",
            "Read",
            "Modify"
          ]
        },
        "wallboard": {
          "defaultValue": "No",
          "values": [
            "No"
          ]
        }
      }
    }
  ]
}

where:

accessPermissions. A collection of feature permissions.
- permissionKey. The key of the feature permission.
- permissionName. The name of the feature permission.
- permissionCategory. The category under which given feature permission is grouped.
- permissionSubCategory. The subcategory under which given feature permission is grouped.
- permissionLevels. Contains list of permission levels available for every system role. Has two properties:
  - defaultValue. The default permission level for given role.
  - values. The list with all permission levels that can be assigned to given role.

Try it out

For information, see Trying out Vonage Contact Center APIs.