---
title: GET Roles
slug: get-roles
createdAt: 2024-10-15T16:25:11.141Z
---
Entity Management (EM) contains role data that is associated to groups. The user, group, role and permission records work in conjunction with each other to control workflow activities and what users can or cannot do within the system. Roles and users are associated to groups using Group Management, and permissions are associated to roles using Role Management.
For more information about the data driving this function, refer to the EM Application Data document.
***
## Purpose
The purpose of the GET Roles API is for the *client* to obtain a complete listing of all role data used within the system from the *server*. Role data values may be required to be included in certain other API requests.
## Components
- **HTTP Method:** GET
- **Server URL:** **{baseurl}**
- **Endpoint:** /roles
- **Headers:** -H 'Content-Type: application/json' -H 'Authorization: Bearer **{token}**'
- **Body:** none
## Curl Code
The Curl code for the above API components would look like the below command where the tags are replaced with the respective values.
curl -X GET '**{baseurl}**/roles -H 'Content-Type: application/json' -H 'Authorization: Bearer **{token}**'
## Request
The table below includes shading to help identify key areas:
- Base API parameters - The base API parameters are shaded green and represent the call parameters.
::::VerticalSplit{layout="middle"}
:::VerticalSplitItem
### Request Data and Parameters
The table below also indicates the required and optional (blank) data and parameters to be provided by the *client*:
- Always - means the value is always required regardless of the action requested (add, remove, update).
- New - means the value is required for a new object being created.
- Existing - means the value is required for an existing object being removed or updated.
- Conditional - means the field is required if the object is present or the specified condition is met.
/
:::
:::VerticalSplitItem
### Request Sample
GET {{baseUrl}}/roles/light?includeInactive=false\&includeSystem=true\&includePlatformSystemRoles=false
:::
::::
| **Field Name** | **Description** |
| ------------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| baseurl `string` Required | Replace with the actual URL of the system environment. |
| token `string` Required | Replace with a valid access token. |
| includeInactive `boolean` | Default is 'false'. Returns only active roles or includes inactive roles based on this value. |
| includeSystem `boolean` | Default is 'false'. Returns only non-system roles or all types of roles based on this value. System roles are managed by the system and are used in specific places within the application (e.g., Entity User Role, Entity Partner Role). |
| includePlatformSystemRoles `boolean` | Default is 'false'. Returns only non-platform system roles or all roles based on this value. Platform roles are managed by the system. This is not used at this time but may appear on some roles. |
## Response
The response is an array of data returned from the *server* to the *client* based on the example request(s) above. The following response codes will be returned:
- **200** = OK: The request was successful.
- 400 = Bad Request: Validation error caused by malformed request. Ensure the payload sent adheres to the requirements.
- 401 = Unauthorized: Authentication error caused by unauthorized token. Provide a valid authentication token.
- 403 = Forbidden: Forbidden resource caused by lack of necessary privilege. Verify end-point URL and resource info.
- 404 = Resource Not Found: The resource is invalid or not available. Verify end-point URL and resource info.
- 415 = Unsupported Media Type: Server is refusing to service the request because the payload is in a format not supported by this method. Verify request payload.
- 500 = Internal Server Error: The system encountered an unexpected problem. Try again or submit a support ticket.
- 503 = Service Unavailable: The service is unavailable due to temporary overload or scheduled maintenance. Try again or submit a support ticket.
### Response Data
The data structure of the array returned in the response is defined below.
| **Field Name** | **Description** |
| -------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- |
| roleId `long` | The unique object identifier of the role. |
| roleName `string` | The name of the role. |
| roleDesc `string` Required | The description of the role. |
| isActive `boolean` | The flag that indicates whether the role is active (true, false). |
| attributes `object` | A list of key\:value pairs associated to the group (e.g., partner role, entity role). |
| attributes.isEntityRole `string` | Indicates if the role is an Entity User Role. If “t”, the role displays in the dropdown list in the user interface. |
| attributes.isPartnerRole `string` | Indicates if the role is an Entity Partner Role. If “t”, the role displays in the dropdown list in the user interface. |
| attributes.is\_platform\_system\_role `string` | Indicates if the role is a system role controlled by the platform |
| transactionId `string` | The system-generated hash/alphanumeric identifier of the workflow instance. |
| isSystemRole `boolean` | Indicates if the role is a system-controlled role. |
| objectTypeCode `long` | The unique object identifier that indicates the type of object the role can be associated to. Values are found in Reference Data as category OBJECT\_TYPE. |
| visible `boolean` | Indicates if the role is visible within the user interface. |
### Response Sample
```json
[
{
"roleId": 10135,
"roleName": "Admin Role",
"roleDesc": "The person holding this role is a system administrator.",
"isActive": true,
"transactionId": "aa62f4b3-6c3a-481c-bf6c-f1ffff670b4a",
"isSystemRole": false,
"visible": true
},
{
"roleId": 106,
"roleName": "Audit",
"roleDesc": "Audit",
"isActive": true,
"attributes": {
"isEntityRole": "t",
"isPartnerRole": "t"
},
"transactionId": "flyway 1.4.5",
"isSystemRole": true,
"objectTypeCode": 70004,
"visible": true
},
{
"roleId": 10134,
"roleName": "Basic Jan User",
"roleDesc": "Starting with minimum.",
"isActive": true,
"transactionId": "a4ed94f8-967a-4a79-ae9e-f34c397960de",
"isSystemRole": false,
"visible": true
},
{
"roleId": 122,
"roleName": "Basic User",
"roleDesc": "Basic User",
"isActive": true,
"transactionId": "dfaf3ede-1bb9-4fee-9cfd-300a29cef6cf",
"isSystemRole": true,
"objectTypeCode": 70007,
"visible": true
},
{
"roleId": 10037,
"roleName": "Collaborator",
"roleDesc": "Collaborator",
"isActive": true,
"transactionId": "flyway 3.7.3",
"isSystemRole": false,
"objectTypeCode": 70007,
"visible": true
},
{
"roleId": 107,
"roleName": "Concurring",
"roleDesc": "Concurring",
"isActive": true,
"attributes": {
"isEntityRole": "t",
"isPartnerRole": "t"
},
"transactionId": "flyway 1.4.4",
"isSystemRole": true,
"objectTypeCode": 70004,
"visible": true
},
{
"roleId": 108,
"roleName": "Consulting",
"roleDesc": "Consulting",
"isActive": true,
"attributes": {
"isEntityRole": "t",
"isPartnerRole": "t"
},
"transactionId": "flyway 1.4.4",
"isSystemRole": true,
"objectTypeCode": 70004,
"visible": true
},
{
"roleId": 10043,
"roleName": "DM - Collaborator",
"roleDesc": "Test collaborator role with less permissions then current out of the box.",
"isActive": true,
"transactionId": "cef8ee0c-9228-4adb-ae38-f7b71ca5ed9f",
"isSystemRole": false,
"visible": true
},
{
"roleId": 10044,
"roleName": "DM - Request Manager",
"roleDesc": "Testing the role with limited permission.",
"isActive": true,
"transactionId": "1ae6e7c8-c083-4562-9cf5-39de2bf19761",
"isSystemRole": false,
"visible": true
},
{
"roleId": 10042,
"roleName": "DM - Request Searcher",
"roleDesc": "This is just a test role that can be granted to users so they can only search and view published requests.",
"isActive": true,
"transactionId": "6ff6b501-53d6-4043-9798-b27d34cb311a",
"isSystemRole": false,
"visible": true
},
{
"roleId": 114,
"roleName": "Eligible to be Responsible Party",
"roleDesc": "Eligible to be Responsible Party",
"isActive": true,
"transactionId": "de57e667-d84d-4285-a1f8-13877dc61218",
"isSystemRole": false,
"visible": true
},
{
"roleId": 103,
"roleName": "Entity Approval Delegate",
"roleDesc": "Entity Approval Delegate",
"isActive": true,
"attributes": {
"isEntityRole": "t"
},
"transactionId": "user_default_transaction",
"isSystemRole": true,
"objectTypeCode": 70004,
"visible": true
},
{
"roleId": 121,
"roleName": "Entity Monitor",
"roleDesc": "Entity Monitor",
"isActive": true,
"transactionId": "561ed7a2-077a-4d9e-b470-e0c50c8c5de3",
"isSystemRole": false,
"visible": true
},
{
"roleId": 109,
"roleName": "FA",
"roleDesc": "FA",
"isActive": true,
"attributes": {
"isEntityRole": "t",
"isPartnerRole": "t"
},
"transactionId": "flyway 1.4.4",
"isSystemRole": true,
"objectTypeCode": 70004,
"visible": true
},
{
"roleId": 115,
"roleName": "Global Level 1 Entity Reviewer",
"roleDesc": "Global Level 1 Entity Reviewer",
"isActive": true,
"transactionId": "user_default_transaction",
"isSystemRole": false,
"objectTypeCode": 70007,
"visible": true
},
{
"roleId": 116,
"roleName": "Global Level 2 Entity Reviewer",
"roleDesc": "Global Level 2 Entity Reviewer",
"isActive": true,
"transactionId": "user_default_transaction",
"isSystemRole": false,
"objectTypeCode": 70007,
"visible": true
},
{
"roleId": -1,
"roleName": "Internal System Administrator",
"roleDesc": "Internal System Administrator",
"isActive": true,
"transactionId": "user_default_transaction",
"isSystemRole": true,
"objectTypeCode": 70007,
"visible": true
},
{
"roleId": 123,
"roleName": "LAP - Approver",
"roleDesc": "LAP - Approver",
"isActive": true,
"attributes": {
"isEntityRole": "t",
"isPartnerRole": "t"
},
"transactionId": "flyway 1.4.5",
"isSystemRole": true,
"objectTypeCode": 70004,
"visible": true
},
{
"roleId": 120,
"roleName": "LAP - Informed Party",
"roleDesc": "LAP - Informed Party",
"isActive": true,
"attributes": {
"isEntityRole": "t",
"isPartnerRole": "t"
},
"transactionId": "flyway 1.4.5",
"isSystemRole": true,
"objectTypeCode": 70004,
"visible": true
},
{
"roleId": 110,
"roleName": "LCSP",
"roleDesc": "Lead Client Service Partner",
"isActive": true,
"attributes": {
"isEntityRole": "t",
"isPartnerRole": "t"
},
"transactionId": "flyway 1.4.4",
"isSystemRole": true,
"objectTypeCode": 70004,
"visible": true
},
{
"roleId": 117,
"roleName": "Member Firm Level 1 Entity Reviewer",
"roleDesc": "Member Firm Level 1 Entity Reviewer",
"isActive": true,
"transactionId": "7c770b89-eabb-4811-85ca-58b6e6bbcc19",
"isSystemRole": false,
"objectTypeCode": 70007,
"visible": true
},
{
"roleId": 118,
"roleName": "Member Firm Level 2 Entity Reviewer",
"roleDesc": "Member Firm Level 2 Entity Reviewer",
"isActive": true,
"transactionId": "2dcd5ac9-a54b-4dd1-9ed3-f1e7f76c6534",
"isSystemRole": false,
"objectTypeCode": 70007,
"visible": true
},
{
"roleId": 101,
"roleName": "Partner Role",
"roleDesc": "Partner Role",
"isActive": true,
"transactionId": "9a61c4f3-c8cf-4212-bb88-9290c36c2a5e",
"isSystemRole": true,
"objectTypeCode": 70007,
"visible": true
},
{
"roleId": 111,
"roleName": "RA",
"roleDesc": "RA",
"isActive": true,
"attributes": {
"isEntityRole": "t",
"isPartnerRole": "t"
},
"transactionId": "flyway 1.4.4",
"isSystemRole": true,
"objectTypeCode": 70004,
"visible": true
},
{
"roleId": 5003,
"roleName": "Request Collaborator",
"roleDesc": "Request Collaborator",
"isActive": true,
"transactionId": "dmp manualscript 1.3.0",
"isSystemRole": false,
"objectTypeCode": 70007,
"visible": true
},
{
"roleId": 5001,
"roleName": "Request Manager",
"roleDesc": "Request Manager",
"isActive": true,
"transactionId": "dmp manualscript 1.3.0",
"isSystemRole": false,
"objectTypeCode": 70007,
"visible": true
},
{
"roleId": 5002,
"roleName": "Request Reviewer",
"roleDesc": "Request Reviewer",
"isActive": true,
"transactionId": "dmp manualscript 1.3.0",
"isSystemRole": false,
"objectTypeCode": 70007,
"visible": true
},
{
"roleId": 102,
"roleName": "Responsible Party",
"roleDesc": "Responsible Party",
"isActive": true,
"attributes": {
"isEntityRole": "t"
},
"transactionId": "user_default_transaction",
"isSystemRole": true,
"objectTypeCode": 70004,
"visible": true
},
{
"roleId": 10035,
"roleName": "SCIM_ROLE",
"roleDesc": "Invoke synchronization API",
"isActive": true,
"transactionId": "flyway 3.4.11",
"isSystemRole": true,
"objectTypeCode": 70007,
"visible": true
},
{
"roleId": 119,
"roleName": "Service Request Management",
"roleDesc": "Service Request Management",
"isActive": true,
"transactionId": "flyway 1.4.1",
"isSystemRole": false,
"objectTypeCode": 70007,
"visible": true
},
{
"roleId": 104,
"roleName": "Services Approval Delegate",
"roleDesc": "Services Approval Delegate",
"isActive": true,
"attributes": {
"isEntityRole": "t"
},
"transactionId": "user_default_transaction",
"isSystemRole": true,
"objectTypeCode": 70004,
"visible": true
},
{
"roleId": 105,
"roleName": "Services Assistance Delegate",
"roleDesc": "Services Assistance Delegate",
"isActive": true,
"attributes": {
"isEntityRole": "t"
},
"transactionId": "user_default_transaction",
"isSystemRole": true,
"objectTypeCode": 70004,
"visible": true
},
{
"roleId": 1,
"roleName": "Supervisor",
"roleDesc": "Supervisor",
"isActive": true,
"transactionId": "f1e1a3b7-6bf9-4d16-95fe-3a2839b49562",
"isSystemRole": true,
"objectTypeCode": 70005,
"visible": true
},
{
"roleId": 5,
"roleName": "System Administrator",
"roleDesc": "System Administrator",
"isActive": true,
"attributes": {
"is_platform_system_role": "false"
},
"transactionId": "cecf5869-9b27-40a6-a231-90cedbe0efed",
"isSystemRole": false,
"objectTypeCode": 70007,
"visible": true
},
{
"roleId": 112,
"roleName": "Tax and Legal",
"roleDesc": "Tax and Legal",
"isActive": true,
"attributes": {
"isEntityRole": "t",
"isPartnerRole": "t"
},
"transactionId": "flyway 1.4.4",
"isSystemRole": true,
"objectTypeCode": 70004,
"visible": true
},
{
"roleId": 113,
"roleName": "Treasury",
"roleDesc": "Treasury",
"isActive": true,
"attributes": {
"isEntityRole": "t",
"isPartnerRole": "t"
},
"transactionId": "flyway 1.4.4",
"isSystemRole": true,
"objectTypeCode": 70004,
"visible": true
},
{
"roleId": 10000,
"roleName": "Unlock",
"roleDesc": "Unlock",
"isActive": true,
"transactionId": "29fa9618-d661-46a9-a567-eeabe9e25cf3",
"isSystemRole": false,
"objectTypeCode": 70007,
"visible": true
}
]
```
## Attachments:
[image2022-4-14\_8-33-20.png](#) (image/png)
[image2022-4-14\_8-31-58.png](#) (image/png)
Document generated by Confluence on Oct 15, 2024 11:10
[Atlassian](http://www.atlassian.com/)