Get Online Users | docs.d3security

Last updated: Aug 08, 2024

Displays a list of users who are currently logged in and active.

Implementation	System
Command Category	System Utility
Tags	User

Inputs

N/A

Output

Return Data

The returned result of this command. If some required parameters are not defined, this returned data could be empty. The returned result can be passed down directly to a subsequent command in playbooks.

Sample Data

JSON

Succeed

Context Data

The response data from the utility command.

Sample Data

JSON

[
    {
        "userID": "1",
        "userName": "demoUserName",
        "firstName": "demoFirstName",
        "lastName": "demoLastName",
        "fullName": "demoFullName",
        "timezoneId": "5",
        "description": "System Administrator",
        "email": "demoEmail@d3security.com",
        "phone": "",
        "loginLogID": "12735",
        "SourceIP": "192.168.1.250",
        "factoryDeviceID": "",
        "activeVSOCUsers": "1",
        "activeMobileUsers": "2"
    }
]

Remote Command API

The D3 command API allows you to send requests to D3 SOAR to execute this utility command via REST API.

Request

POST

https:/{base_url}/{api_namespace}/api/Command/GetOnlineUsers

Headers

Please refer to the page Webhook Configuration Guide - Authentication Method: API Keys for more details.

Request Body

JSON

{
  "Username": <Username here>,
  "Site": <Site here>,
  "CommandParams": {
  }
}

Body Parameters

Parameter Name	Type	Required/Optional	Description
Username	`string`	Required	The username of your D3 SOAR account.
Site	`string`	Required	The D3 SOAR site to run the remote command.

Sample Request

Sample Data

JSON

{
  "Username": "Admin",
  "Site": "Security Operations",
  "CommandParams": {}
}

Response

Response Fields

Field Name	Type	Description
error	`string`	The error message if the API request has failed.
result	`string`
returnData	`string`	The return data from the API request.
contextData	`array<JSON Object>`	The response data from the utility command.

Sample Response

JSON

{
    "error": "",
    "result": "<table class='cc-table'><th>User Name</th><th>First Name</th><th>Last Name</th><th>Email</th><th>Login IP</th><th>Active Mobile User</th><tr><td>demoUserName</td><td>demoFirstName</td><td>demoLastName</td><td>demoEmail@d3security.com</td><td>192.168.1.250</td><td>2</td></tr></table>",
    "returnData": "Succeed",
    "contextData": [
      {
          "userID": "1",
          "userName": "demoUserName",
          "firstName": "demoFirstName",
          "lastName": "demoLastName",
          "fullName": "demoFullName",
          "timezoneId": "5",
          "description": "System Administrator",
          "email": "demoEmail@d3security.com",
          "phone": "",
          "loginLogID": "12735",
          "SourceIP": "192.168.1.250",
          "factoryDeviceID": "",
          "activeVSOCUsers": "1",
          "activeMobileUsers": "2"
      }
  ]
}