Retrieve list of all role details

Retrieves a paginated list of all roles configured in the system, including role names, descriptions, and creation timestamps. Supports page-based pagination via the page and pageLimit parameters.

Endpoints

get /emsapi/roles/details

Copy full URL

Request URL

https://{serverurl}/emsapi/roles/details

Scope

DesktopCentralCloud.Admin.READCopied!

Header

Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

Request Parameters

- Query Parameters

pageintegerOptional

Page number for pagination. Starts from 1. Returns the first page if not specified.

pageLimitintegerOptional

Maximum number of role records to return per page. Uses system default if not specified. Value can be upto 1000

Sample Request

Curl

Java

Python

Deluge

PowerShell

Copied!

curl --request GET \
  --url https://appdomains/emsapi/roles/details \
  --header 'Authorization: Zoho-oauthtoken  d92d4xxxxxxxxxxxxx15f52'

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
import java.io.IOException;
import java.net.http.HttpTimeoutException;

public class Main {
  public static void main(String[] args) {

    HttpRequest request = HttpRequest.newBuilder()
        .uri(URI.create("https://appdomains/emsapi/roles/details"))
        .header("Authorization", "Zoho-oauthtoken  d92d4xxxxxxxxxxxxx15f52")
        .method("GET", HttpRequest.BodyPublishers.noBody())
        .build();
    HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
    System.out.println(response.body());
  
  }
}

import http.client

conn = http.client.HTTPSConnection("appdomains")

headers = { 'Authorization': "Zoho-oauthtoken  d92d4xxxxxxxxxxxxx15f52" }

conn.request("GET", "/emsapi/roles/details", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))


    headersMap = Map();
    headersMap.put("Accept", "application/json");

    response = invokeUrl
    [
        url: "https://appDomains/emsapi/roles/details"
        type: GET
        headers: headersMap
        connection: connection_name
    ]

    info response;

$headers=@{}
$headers.Add("Authorization", "Zoho-oauthtoken  d92d4xxxxxxxxxxxxx15f52")
$response = Invoke-WebRequest -Uri 'https://appdomains/emsapi/roles/details' -Method GET -Headers $headers

Response Parameters

- HTTP code 200

Response Body - application/json

JSON Object

Hide Sub-Attributes

metadataJSON Object

Pagination metadata for the current page.

Show Sub-Attributes

limitlong

Maximum number of records returned in the current page.

pagelong

Current page number in the paginated result.

totalRecordsstring

Total number of role records available in the system.

messageResponseJSON Array

List of role details returned for the current page.

Show Sub-Attributes

JSON Object

Show Sub-Attributes

creation_timestring

Timestamp when the role was created.

modified_timestring

Timestamp when the role was last modified.

um_role_idstring

Unique identifier for the role.

is_editablestring

Indicates whether the role can be edited ('true' or 'false').

um_role_namestring

Name of the role.

um_role_descriptionstring

Description of the role and its access level.

admin_namestring

Administrator account associated with the role.

totalPageslong

Total number of pages available for the given page limit.

LinksJSON Object

Pagination links for navigating to the next and previous pages.

Show Sub-Attributes

nextstring

Link to the next page; null when no next page exists.

prevstring

Link to the previous page; null when no previous page exists.

statusstring

Response status. 'success' indicates the role list was fetched successfully.

Possible Response Codes

200HTTP code

Sample Response: HTTP 200

Paginated list response for role details with metadata and navigation links.

Copied!

  {
    "metadata": {
      "limit": 25,
      "page": 1
    },
    "totalRecords": "5",
    "messageResponse": [
      {
        "creation_time": "Nov 3, 2025 12:15 PM",
        "modified_time": "Nov 3, 2025 12:15 PM",
        "um_role_id": "1",
        "is_editable": "false",
        "um_role_name": "Security Auditor",
        "um_role_description": "Read-only access for audit and compliance review.",
        "admin_name": "System Administrator"
      },
      {
        "creation_time": "Nov 3, 2025 12:15 PM",
        "modified_time": "Nov 3, 2025 12:15 PM",
        "um_role_id": "4",
        "is_editable": "true",
        "um_role_name": "Endpoint Technician",
        "um_role_description": "Operational access for routine endpoint management tasks.",
        "admin_name": "System Administrator"
      },
      {
        "creation_time": "Nov 3, 2025 12:15 PM",
        "modified_time": "Nov 3, 2025 12:15 PM",
        "um_role_id": "3",
        "is_editable": "false",
        "um_role_name": "Patch Administrator",
        "um_role_description": "Full access to patch deployment and remediation workflows.",
        "admin_name": "System Administrator"
      },
      {
        "creation_time": "Nov 3, 2025 12:15 PM",
        "modified_time": "Nov 3, 2025 12:15 PM",
        "um_role_id": "6",
        "is_editable": "true",
        "um_role_name": "Asset Analyst",
        "um_role_description": "Read-only access to inventory and asset insights.",
        "admin_name": "System Administrator"
      },
      {
        "creation_time": "Nov 3, 2025 12:15 PM",
        "modified_time": "Nov 3, 2025 12:15 PM",
        "um_role_id": "2",
        "is_editable": "true",
        "um_role_name": "Service Desk Operator",
        "um_role_description": "Limited operational access for help desk support tasks.",
        "admin_name": "System Administrator"
      }
    ],
    "totalPages": 1,
    "Links": {
      "next": null,
      "prev": null
    },
    "status": "success"
  }

▼ Show full

Page 2 result when multiple pages exist. Shows pagination with next and previous links populated.

Copied!

  {
    "metadata": {
      "limit": 3,
      "page": 2
    },
    "totalRecords": "8",
    "messageResponse": [
      {
        "creation_time": "Nov 5, 2025 02:30 PM",
        "modified_time": "Nov 5, 2025 02:30 PM",
        "um_role_id": "7",
        "is_editable": "true",
        "um_role_name": "Network Administrator",
        "um_role_description": "Full access to network management and configuration.",
        "admin_name": "System Administrator"
      },
      {
        "creation_time": "Nov 6, 2025 10:15 AM",
        "modified_time": "Nov 6, 2025 10:15 AM",
        "um_role_id": "8",
        "is_editable": "true",
        "um_role_name": "Software Deployment Manager",
        "um_role_description": "Manage software deployment and updates across all endpoints.",
        "admin_name": "System Administrator"
      },
      {
        "creation_time": "Nov 7, 2025 03:45 PM",
        "modified_time": "Nov 7, 2025 03:45 PM",
        "um_role_id": "9",
        "is_editable": "false",
        "um_role_name": "Read-Only User",
        "um_role_description": "View-only access to all modules without modification rights.",
        "admin_name": "System Administrator"
      }
    ],
    "totalPages": 3,
    "Links": {
      "next": "/emsapi/roles/details?page=3&limit=3",
      "prev": "/emsapi/roles/details?page=1&limit=3"
    },
    "status": "success"
  }

▼ Show full

Duration: 1 minute | Threshold: 30 | Lock period: 5 minutes

Duration - Time window for the threshold.
Threshold - Number of API calls allowed within the specified duration.
Lock Period - Wait time before consecutive API requests.