User details: Request

To get details about a specific NDR appliance user, send the following request:

GET  https://<Network Detection and Response_IP_address>/config/v1/users/<user>

Required header:

--user <username>:<password>

Options

IA_IP_address—IP address of the NDR appliance running the NDR API.
username—Your username.
password—Your password.

Parameters

user (path parameter)—The username of a user whose details you need to retrieve.

Example

GET https://xxx.xxx.xxx.xxx/config/v1/users/jdoe

Required header:

--user npadmin:hammerhead

User details: Response

HTTP/1.1 [Response Code] [Response Message]
Date: [Date]
Content-Type: [Content Type]
{				
"username": "[User Name]"
"name": "[Full Name]"		
"groups": "[Groups]"
}

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 username of the user whose details you retrieved.
Full Name—The full name of the user whose details you retrieved.
Groups—Groups of NDR appliance users that include the specified user.

Example

HTTP/1.1 200 OK
Date: Tue, 24 Jan 2017 18:58:06 GMT
Content-Type: application/json; charset=utf-8

{
  "username": "jdoe",
  "name": "Jane Doe",
  "groups": [
    "wheel",
    "klish",
    "uiapi"
  ]
}

cURL code sample: User details

The code sample was run with cURL 7.57.0.

curl -k --user npadmin:hammerhead https://xxx.xxx.xxx.xxx/config/v1/users/jdoe -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 username. Replace hammerhead with your password.
https://xxx.xxx.xxx.xxx/config/v1/users/jdoe—The users request URL. Replace xxx.xxx.xxx.xxx with the IP address of your NDR appliance. Replace jdoe with the user name of the user whose details you want to retrieve.
-X GET—This option specifies using the GET method.

Results

This example returns details about the specified NDR appliance user. The output is in JSON format.