Get All Users

LAST UPDATED: AUG 08, 2024

Retrieves a complete list of all user accounts.

Implementation	System
Command Category	Cyber Utility
Tags	`User`

Inputs

Parameter Name

Required/Optional

Description

Sample Data

Online

Required

Two options:

Yes: display only online users
No: display both online and offline users

Yes

Output

Return Data

The response data from the utility command.

JSON

[
    {
        "userID": "21",
        "userName": "demoUserName",
        "firstName": "demoFirstName",
        "lastName": "demoLastName",
        "fullName": "demoFullName",
        "timezone": "W. Europe Standard Time",
        "timezoneId": "30",
        "description": "System Administrator",
        "email": "demoUserName@d3security.com",
        "phone": "6041234567"
    },
    {
        "userID": "22",
        "userName": "demoUserName2",
        "firstName": "demoFirstName2",
        "lastName": "demoLastName2",
        "fullName": "demoFullName2",
        "timezone": "Hawaiian Standard Time",
        "timezoneId": "3",
        "description": "System Administrator",
        "email": "demoUserName2@d3security.com",
        "phone": "6047654321"
    }
]

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

CODE

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

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": {
    "Online": <Online here>
  }
}

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.
Online	`boolean`	Required	Display only online users when Online is selected as Yes. Otherwise, display both online and offline users.

Sample Request

SAMPLE DATA

JSON

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

Response

Response Fields

Field Name	Type	Description
error	`string`	The error message if the API request has failed.
returnData	`JSON Object`	The return data from the API request.

Sample Response

JSON

{
    "error": "",
    "returnData": [
        {
            "userID": "21",
            "userName": "demoUserName",
            "firstName": "demoFirstName",
            "lastName": "demoLastName",
            "fullName": "demoFullName",
            "timezone": "W. Europe Standard Time",
            "timezoneId": "30",
            "description": "System Administrator",
            "email": "demoUserName@d3security.com",
            "phone": "6041234567"
        },
        {
            "userID": "22",
            "userName": "demoUserName2",
            "firstName": "demoFirstName2",
            "lastName": "demoLastName2",
            "fullName": "demoFullName2",
            "timezone": "Hawaiian Standard Time",
            "timezoneId": "3",
            "description": "System Administrator",
            "email": "demoUserName2@d3security.com",
            "phone": "6047654321"
        }
    ]
}