Data node user details: Request

To retrieve details of a data node user, send the following request:

GET https://<IA_director_node_IP_address>/config/v1/users/<data_node_IP_address>/<user>

Required header:

--user <username>:<password>

Options

IA_director_node_IP_address—IP address of the director node NDR appliance running the NDR API.
username—Administrator username for the director node.
password—Administrator password for the director node.

Parameters

data_node_IP_address (path parameter)—IP address of an NDR data node appliance.
user (path parameter)—The username of a user whose details you need to retrieve.

Example

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

Required header:

--user npadmin:hammerhead

Data node user details: 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 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.
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:58:06 GMT
Content-Type: application/json; charset=utf-8

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

}

cURL code sample: Data node 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/yyy.yyy.yyy.yyy/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 the administrator username for the director node. Replace hammerhead with the corresponding administrator password for the director node.
https://xxx.xxx.xxx.xxx/config/v1/users/yyy.yyy.yyy.yyy/jdoe —Replace xxx.xxx.xxx.xxx with the IP address of the director node. Replace yyy.yyy.yyy.yyy with the IP address of a data node whose details you wish to retrieve. Replace jdoe with the user name of the user whose details you wish to retrieve.
-X GET—This option specifies using the GET method.

Results

This example returns details about the specified data node user. The output is in JSON format.