--- title: "New user: Request" slug: "new-user-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/new-user-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. # New user: Request To add a user to the NDR appliance, send the following request: ``` POST https:///config/v1/users ``` > [!NOTE] > Note > > To use this request, you must belong to the sudo group. Required header: ``` --user : ``` Request body: ``` {   user: 'TEXT',   name: 'TEXT',   group: 'TEXT',   password: 'TEXT'     remote: 'Boolean' } ``` ### Options - IA_IP_address—IP address of the NDR appliance running the NDR API. - username— Administrator username. - password—Administrator password. ###### Parameters - `user`—The user name of a new user for an NDR appliance. - `name`—The full name of the new user. - `group`—A group of NDR appliance users that will include the new user. You can also specify multiple groups; valid values are uiapi, klish, and wheel. - `password` (optional)—The password for the new user. You need to specify a password only for a non-remote user. - `remote` (Boolean)—"true" enables the user to be a remote user; "false" enables the user to be a non-remote user. ### Example ``` POST https://xxx.xxx.xxx.xxx/config/v1/users ``` Required header: ``` --user npadmin:hammerhead ``` Request body: ``` {   user: jdoe,   name: Jane Doe,   group: klish,   password: abcdef12345,   remote:false } ``` ### New user: 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. - User Name—The user name of the new user. - Full Name—The full name of the new user. - Groups—Groups of the NDR appliance users that include the new user. - Remote Status—Specifies whether the user is a remote user (Y) or a non-remote user (N). ### Example ``` HTTP/1.1 100 Continue HTTP/1.1 200 OK Date: Tue, 24 Jan 2017 18:38:24 GMT Content-Type: application/json; charset=utf-8 {  "username": "jdoe",  "name": "Jane Doe",  "groups": "klish",  "remote": "N" } ``` ### cURL code sample: New user The code sample was run with cURL 7.57.0. ``` curl -k --user npadmin:hammerhead --insecure https://xxx.xxx.xxx.xxx/config/v1/users -X POST -F user=jsmith -F "name=Jim Smith" -F group=uiapi -F password=a8Cb2cdH2eJ7f@ -F remote=false ``` 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 the user name of the administrator for your NDR appliance. Replace `hammerhead` with the corresponding administrator password for your NDR appliance. - `https://xxx.xxx.xxx.xxx/config/v1/users`—The users request URL. Replace `xxx.xxx.xxx.xxx` with the IP address of your NDR appliance. - `-X POST`—This option specifies using the POST method. - `-F user=jsmith`—This option specifies the user name of the new user. - `-F "name=Jim Smith"`—This option specifies the full name of the new user. - `-F group=uiapi`—This option specifies a group that will include the new user. - `-F password=a8Cb2cdH2eJ7f@`—This option specifies the password for the new user. - `-F remote=false`—This option enables the new user to be a non-remote user. ### Results This example adds a user to the NDR appliance. The output is in JSON format.