Get The Least Busy User‎

POST /Command/GetTheLeastBusyUser

Identifies the user with the lowest current workload based on specified criteria.

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.
Online	`boolean`	Optional	Check if the users are online. (Options: “Yes“ or “No“)
Least Incidents	`boolean`	Optional	Get users with least incidents. (Options: “Yes“ or “No“)
Least Events	`boolean`	Optional	Get users with least events. (Options: “Yes“ or “No“)
Least Pending Tasks	`boolean`	Optional	Get users with least pending tasks. (Options: “Yes“ or “No“)
Randomize	`boolean`	Optional	If Randomize is Yes, return a list containing only one random qualified user. (Options: “Yes“ or “No“)
Incident Number	`string`	Optional	If command not runs under a Playbook, incident number input is required. If command runs under a Playbook, then incident number is optional. If command runs under a Playbook and incident number input provided, then command will use inputted incident case number. Incident number filters users whom has access to the incident.

Body Sample Data

application/json

JSON

{
  "Username": "Admin",
  "Site": "Security Operations",
  "CommandParams": {
    "Online": "Yes",
    "Least Incidents": "Yes",
    "Least Events": "Yes",
    "Least Pending Tasks": "Yes",
    "Randommize": "Yes",
    "Incident Number": "20211126-4"
  }
}

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	`array<JSON Object>`	The context data from the API request.

Sample Data

CODE

{
    "error":"",
    "returnData":"Successful",
    "contextData":[
        {
            "ID": 1,
            "Email": "xxxx@d3security.com",
            "User Name": "user, admin"
        }
    ]
}

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."}