These URLs retrieve the details of the all the roles.
Resource URL
GET /role
This URL is used to retrieve the details of all the roles.
Request Parameters
No request parameters are required for this URL.
Response Parameters
Following fields are returned if the request parameters are correct, otherwise error details are returned.
| Field Name | Description | Data Type |
|---|---|---|
| customRoleList | An array containing details of all the roles. | Array |
Details of CustomRole object (an element in customRoleList):
| Field Name | Description | Data Type |
|---|---|---|
| roleName | Name of the role as displayed in the Manager | String |
| description | The description of the role that is given while creating the role | String |
| privileges | List of the privileges that the role has. It can have following values like:
|
Array |
Example
Request
GET https://<NSM_IP>/sdkapi/role
Response
{
"customRoleList": [
{
"roleName": "ePO Dashboard Data Retriever",
"description": "Special role for use with the ePO Extension to pull NSP data from ePO for display in ePO Dashboards.",
"privileges":
[
"ePO Dashboard Data Retrieval"
]
},
{
"roleName": "Crypto Administrator",
"description": "Add and remove devices.",
"privileges":
[
"Devices - Edit"
]
},
{
"roleName": "Audit Administrator",
"description": "Administer user activity logs.",
"privileges":
[
"User Auditing - Edit"
]
}
]
}