To remove an NDR appliance user, send the following request:
DELETE https://<IA_IP_address>/config/v1/users/<user>
Note
To use this request, you must belong to the sudo group.
Required header:
--user <username>:<password>
Options
IA_IP_address—IP address of the NDR appliance running the NDR API.
username—Administrator username.
password—Administrator password.
Parameters
user(path parameter)—The user name of the user that you want to delete.
Example
DELETE https://xxx.xxx.xxx.xxx/config/v1/users/jsmith
Required header:
--user npadmin:hammerhead
Remove a user: Response
HTTP/1.1 [Response Code] [Response Message] Date: [Date] Content-Type: [Content Type] error:[error message if the delete operation is unsuccessful] httpStatus:[Response Code] success:[Boolean]
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.
Boolean—Status of deletion (true or false)
Example
HTTP/1.1 200 OK
Date: Tue, 24 Jan 2017 21:30:31 GMT
Content-Type: application/json; charset=utf-8
{
"error": "",
"httpStatus":200,
"success": true
}cURL code sample: Remove a user
The code sample was run with cURL 7.57.0.
curl -k --user npadmin:hammerhead https:///xxx.xxx.xxx.xxx/config/v1/users/msmith -X DELETE
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—Replacenpadminwith administrator username. Replacehammerheadwith administrator password.https://xxx.xxx.xxx.xxx/config/v1/users/msmith—The users request URL. Replacexxx.xxx.xxx.xxxwith the IP address of your NDR appliance. Replacemsmithwith the user name of the user you wish to remove.-X DELETE—This option specifies using the DELETE method.
Results
This example removes the specified NDR appliance user. The output is in JSON format.