---
title: "Get the Details of Custom Roles"
slug: "get-the-details-of-custom-roles"
tags: ["Reference", "IPS 10.1.10"]
updated: 2026-09-23T09:36:53Z
published: 2026-09-23T09:36:53Z
canonical: "docs.trellix.com/get-the-details-of-custom-roles"
---
> ## Documentation Index
> Fetch the complete documentation index at: https://docs.trellix.com/llms.txt
> Use this file to discover all available pages before exploring further.
# Get the Details of Custom Roles
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: - Manage Manager - View only - NTBA policy - Edit - Deploy changes - IPS etc. Other available privileges as visible in the Manager based on the types of devices added in the Manager | Array |
## Example
**Request**
GET [https:///sdkapi/role](https://%3CNSM_IP%3E/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"
]
}
]
}
```