--- title: "List users: Request" slug: "list-users-request" tags: ["Reference", "NDRC 4.x", "Customer", "Network Security", "NDR 4.x"] updated: 2026-09-09T18:07:51Z published: 2026-09-09T18:07:51Z canonical: "docs.trellix.com/list-users-request" --- > ## 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. # List users: Request To list all NDR appliance users, send the following request: ``` GET https:///config/v1/users ``` Required header: ``` --user : ``` ### Options - IA_IP_address—IP address of the NDR appliance running the NDR API. - username—Administrator username. - password—Administrator password. ### Example ``` GET https://xxx.xxx.xxx.xxx/config/v1/users ``` Required header: ``` --user npadmin:hammerhead ``` ### Response ``` HTTP/1.1 [Response Code] [Response Message] Date: [Date] Content-Type: [Content Type] username: [User Name] name: [Full Name] groups: [Groups] remote: [Remote Status] ``` ### Response fields - Response Code—A standard HTTP response code. - Response Message—A standard HTTP response message. - Date—Standard HTML date format. - Content Type—The response format. - Category—The category of the appliance. - Count—The full name of a user. - Groups—Groups to which a user belongs. - Remote Status—Specifies whether a user is a remote user (Y) or a non-remote user (N). ### Example ``` HTTP/1.1 200 OK Date: Tue, 24 Jan 2017 18:57:04 GMT Content-Type: application/json; charset=utf-8 [  {    "username": "npadmin",    "name": "",    "groups": [      "wheel",      "klish",      "uiapi"    ],  "remote": "Y"  },  {    "username": "jsmith",    "name": "",    "groups": [      "klish"    ],  "remote": "Y"  },  {    "username": "msmith",    "name": "Mary Smith",    "groups": [      "wheel",      "klish",      "uiapi"    ], "remote": "N"  } ] ``` ### cURL code sample ``` curl -k --user npadmin:hammerhead https://xxx.xxx.xxx.xxx/config/v1/users -X GET ``` This cURL sample includes the following options: - `-k`—This option explicitly allows cURL to perform insecure SSL connections and transfers, which allows you to test your SSL connection without installing a CA certificate. - `--user npadmin:hammerhead`—Replace `npadmin` with your user name. Replace `hammerhead` with your password. - `https://xxx.xxx.xxx.xxx/config/v1/cad?stime`—The users request URL. Replace `xxx.xxx.xxx.xxx` with the IP address of your NDR appliance. - `-X GET`—This option specifies using the GET method. ### Results This example returns a list of all NDR appliance categories. The output is in JSON format.