Get User by Full Name

LAST UPDATED: AUG 08, 2024

Finds a user by matching the provided first and last names.

Implementation	System
Command Category	Cyber Utility
Tags	`User`

Inputs

Parameter Name	Required/Optional	Description	Sample Data
First Name	Required	First name of the user	Robert
Last Name	Required	Last name of the user	Johnson

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

CODE

[
    {
        "userID": 3,
        "userName": "demoUserName",
        "firstName": "demoFirstName",
        "lastName": "demoLastName",
        "fullName": "demoFullName",
        "timezone": "Pacific Standard Time",
        "timezoneId": 5,
        "roleDescription": "System Administrator",
        "email": "demoUserName@d3security.com",
        "phone": "6041234567",
        "role": "admin"
    }
]

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/GetUserByFullName

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": {
    "First Name": <First Name here>,
    "Last Name":  <Last Name 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.
First Name	`string`	Required	First name of the user
Last Name	`string`	Required	Last name of the user

Sample Request

SAMPLE DATA

JSON

{
  "Username": "Admin",
  "Site": "Security Operations",
  "CommandParams": {
    "First Name": "demoFirstName",
    "Last Name": "demoLastName"
  }
}

Response

Response Fields

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

Sample Response

JSON

{
    "error": "",
    "returnData": [
        {
            "userID": 3,
            "userName": "demoUserName",
            "firstName": "demoFirstName",
            "lastName": "demoLastName",
            "fullName": "demoFullName",
            "timezone": "Pacific Standard Time",
            "timezoneId": 5,
            "roleDescription": "System Administrator",
            "email": "demoUserName@d3security.com",
            "phone": "6041234567",
            "role": "admin"
        }
    ]
}