Get Online Users
Displays a list of users currently logged in and active.
Implementation | System |
Command Category | System Utility |
Tags | USER |
Inputs
N/A
Output
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
{
"Username": <Username here>,
"Site": <Site here>,
"CommandParams": {
}
}
Body Parameters
Parameter Name | Type | Required/Optional | Description |
---|---|---|---|
Username |
| Required | The username of your D3 SOAR account. |
Site |
| Required | The D3 SOAR site to run the remote command. |
Sample Request
SAMPLE DATA
{
"Username": "Admin",
"Site": "Security Operations",
"CommandParams": {}
}
Response
Response Fields
Field Name | Type | Description |
---|---|---|
error |
| The error message if the API request has failed. |
returnData |
| The return data from the API request. |
contextData |
| The response data from the utility command. |
Sample Response
{
"error": "",
"returnData": "Succeed",
"contextData": [
{
"userID": "1",
"userName": "admin",
"firstName": "admin",
"lastName": "user",
"fullName": "admin user",
"timezoneId": "5",
"description": "System Administrator",
"email": "awang@d3security.com",
"phone": "",
"loginLogID": "12735",
"SourceIP": "",
"factoryDeviceID": "",
"activeVSOCUsers": "1",
"activeMobileUsers": "0"
}
]
}