| .. |
| .. Copyright 2015 Comcast Cable Communications Management, LLC |
| .. |
| .. Licensed under the Apache License, Version 2.0 (the "License"); |
| .. you may not use this file except in compliance with the License. |
| .. You may obtain a copy of the License at |
| .. |
| .. http://www.apache.org/licenses/LICENSE-2.0 |
| .. |
| .. Unless required by applicable law or agreed to in writing, software |
| .. distributed under the License is distributed on an "AS IS" BASIS, |
| .. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| .. See the License for the specific language governing permissions and |
| .. limitations under the License. |
| .. |
| |
| .. _to-api-v11-roles: |
| |
| Roles |
| ===== |
| |
| .. _to-api-v11-roles-route: |
| |
| /api/1.1/roles |
| ++++++++++++++ |
| |
| **GET /api/1.1/roles.json** |
| |
| Authentication Required: Yes |
| |
| **Response Properties** |
| |
| +----------------------+--------+------------------------------------------------+ |
| | Parameter | Type | Description | |
| +======================+========+================================================+ |
| |``name`` | string | | |
| +----------------------+--------+------------------------------------------------+ |
| |``id`` | string | | |
| +----------------------+--------+------------------------------------------------+ |
| |``privLevel`` | string | | |
| +----------------------+--------+------------------------------------------------+ |
| |``description`` | string | | |
| +----------------------+--------+------------------------------------------------+ |
| |
| **Response Example** :: |
| |
| { |
| "response": [ |
| { |
| "name": "read-only", |
| "id": "2", |
| "privLevel": "10", |
| "description": "read-only user" |
| } |
| ], |
| } |
| |