List data node users: Request

To list all the users of an NDR appliance data node, send the following request to its director node:

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

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 a data node NDR appliance whose users you wish to retrieve.

Example

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

Required header:

--user npadmin:hammerhead

List data node users: 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 a user.
Full Name—The full name of a user.
Groups—The 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": "N"

  },
  {
    "username": "jsmith",
    "name": "",
    "groups": [
      "klish"
    ],
  "remote": "Y"
  },
  {
    "username": "msmith",
    "name": "Mary Smith",
    "groups": [
      "wheel",
      "klish",
      "uiapi"
    ],
    "remote": "N"
  }
]

cURL code sample: List data node users

curl -k --user npadmin:hammerhead https://xxx.xxx.xxx.xxx/config/v1/users/forward/yyy.yyy.yyy.yyy -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/forward/yyy.yyy.yyy.yyy—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 users you wish to retrieve.
-X GET—This option specifies using the GET method.

Results

This example returns a list of all the users of the specified data node. The output is in JSON format.