Retrieve a paginated list of all users in the organization

Open in ChatGPT Open in ChatGPT to ask questions about this page
Open in Claude Open in Claude to ask questions about this page
Copy as MarkdownCopy this page as markdown to use with AI assistants
View as Markdown Open this page as markdown in a new tab

Retrieves a paginated list of all users configured in the organization, including their login ID, role, email, phone number, creation time, and account status. Supports page-based pagination.

Endpoints

Request URL

https://{server-hostname}:8383/emsapi/users/info

Scope

Admin.READCopied!

Header

Authorization: d92d4xxxxxxxxxxxxx15f52

Sample Request

Curl
Java
Python
Deluge
PowerShell
Copied!
curl --request GET \
  --url https://appdomain/emsapi/users/info \
  --header 'Authorization:  d92d4xxxxxxxxxxxxx15f52'
Show full

Response Parameters

- HTTP code 200

Response Body - application/json
JSON object
Hide Sub-Attributes
metadataJSON object

Pagination metadata describing the current page and applied limit.

Show Sub-Attributes
limitinteger

Maximum number of user records per page.

pageinteger

Current page number.

totalRecordsstring

Total number of users available across all pages.

messageResponseJSON array

Paginated list of user detail objects.

Show Sub-Attributes
JSON object
Show Sub-Attributes
creation_timestring

Timestamp when the user was created.

login_idstring

Unique login identifier for the user.

modified_timestring

Timestamp when the user was last modified.

domainnamestring

Authentication domain of the user (e.g., Local).

emailidstring

Email address of the user.

um_role_namestring

Name of the role assigned to the user.

landlinestring

Phone number of the user.

first_namestring

Display name of the user.

created_bystring

Login identifier of the user who created this account.

statusstring

Current account status of the user.

totalPagesinteger

Total number of pages for the current page limit.

LinksJSON object

Pagination navigation links for next and previous pages.

Show Sub-Attributes
nextstring

Link to next page; null when current page is the last page.

prevstring

Link to previous page; null when current page is the first page.

statusstring

Operation result indicator.

Possible Response Codes

200HTTP code

Sample Response: HTTP 200

Paginated list of users with role and status details.

Copied!
  {
    "metadata": {
      "limit": 25,
      "page": 1
    },
    "totalRecords": "3",
    "messageResponse": [
      {
        "creation_time": "Nov 3, 2025 01:13 PM",
        "login_id": "1",
        "modified_time": "Nov 3, 2025 01:13 PM",
        "domainname": "Local",
        "emailid": "alex.morgan@example.com",
        "um_role_name": "Security Auditor",
        "landline": "22222676",
        "first_name": "Alex Morgan",
        "created_by": "1",
        "status": "Not Active"
      },
      {
        "creation_time": "Nov 3, 2025 01:13 PM",
        "login_id": "302",
        "modified_time": "Nov 3, 2025 01:13 PM",
        "domainname": "Local",
        "emailid": "priya.shah@example.com",
        "um_role_name": "Security Auditor",
        "landline": "22222676",
        "first_name": "Priya Shah",
        "created_by": null,
        "status": "Not Active"
      },
      {
        "creation_time": "Nov 3, 2025 01:13 PM",
        "login_id": "301",
        "modified_time": "Nov 3, 2025 01:13 PM",
        "domainname": "Local",
        "emailid": "daniel.lee@example.com",
        "um_role_name": "Security Auditor",
        "landline": "22222676",
        "first_name": "Daniel Lee",
        "created_by": null,
        "status": "Not Active"
      }
    ],
    "totalPages": 1,
    "Links": {
      "next": null,
      "prev": null
    },
    "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.