Get Online Users‎

POST /Command/GetOnlineUsers

Displays a list of users currently logged in and active.

Request

Authentication: API keys or JSON web tokens (JWT)

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.

Body Sample Data

application/json

JSON

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

Response

200 OK

application/json

Response Fields

Field Name	Type	Description
error	`string`	The error message if the command execution failed.
returnData	`string`	The return data from the API request.
contextData	`JSON Array`	The response data from the utility command.

Sample Data

CODE

{
    "error": "",
    "returnData": "Succeed",
    "contextData": [
      {
          "userID": "1",
          "userName": "admin",
          "firstName": "admin",
          "lastName": "user",
          "fullName": "admin user",
          "timezoneId": "5",
          "description": "System Administrator",
          "email": "johndoe@gmail.com",
          "phone": "",
          "loginLogID": "1111",
          "SourceIP": "",
          "factoryDeviceID": "",
          "activeVSOCUsers": "1",
          "activeMobileUsers": "0"
      }
  ]
}

400 BadRequest

application/json

Response Fields

Field Name	Type	Description
Error	`string`	A error message when the API request fails.

Sample Data

JSON

{"Error": "The body of the request must be a valid JSON object"}

401 Unauthorized

application/json

Response Fields

Field Name	Type	Description
Error	`string`	A error message when the API request fails.

Sample Data

JSON

{"Error": "Invalid authentication key."}

429 TooManyRequests

application/json

Response Fields

Field Name	Type	Description
Error	`string`	A error message when the API request fails.

Sample Data

JSON

{"Error": "The request exceeds rate limits or is otherwise blocked by rate limiting policies."}

500 InternalServerError

application/json

Response Fields

Field Name	Type	Description
Error	`string`	A error message when the API request fails.

Sample Data

JSON

{"Error": "Unexpected Error."}