Get User with Email Address

Last updated: Aug 08, 2024

Gets user's account information with a specified Email Address

Implementation	System
Command Category	Cyber Utility
Tags	Condition artifact user

Inputs

Parameter Name	Required/Optional	Description	Sample Data
Email Address	Required	User's Email address used in his/her account	example@d3security.com

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

JSON

Succeed

Context Data

The response data from the utility command.

Sample Data

JSON

[
    {
        "userID": "100093",
        "userName": "cHanks",
        "firstName": "Cindy",
        "lastName": "Hanks",
        "fullName": "Cindy Hanks",
        "timezoneId": "31",
        "description": "System Administrator",
        "email": "example@d3security.com",
        "phone": "1"
    },
    {
        "userID": "100112",
        "userName": "jHanks",
        "firstName": "j",
        "lastName": "Hanks",
        "fullName": "j Hanks",
        "timezoneId": "13",
        "description": "System Administrator",
        "email": "example@d3security.com",
        "phone": "1"
    }
]

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

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": {
    "Email Address": <Email Address 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.
Email Address	`string`	Required	User's Email address used in his/her account

Sample Request

Sample Data

JSON

{
  "Username": "Admin",
  "Site": "Security Operations",
  "CommandParams": {
    "Email Address": "example@d3security.com"
  }
}

Response

Response Fields

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

Sample Response

JSON

{
    "error": "",
    "returnData": "Succeed",
    "contextData": [
        {
            "userID": "100093",
            "userName": "cHanks",
            "firstName": "Cindy",
            "lastName": "Hanks",
            "fullName": "Cindy Hanks",
            "timezoneId": "31",
            "description": "System Administrator",
            "email": "example@d3security.com",
            "phone": "1"
        },
        {
            "userID": "100112",
            "userName": "jHanks",
            "firstName": "j",
            "lastName": "Hanks",
            "fullName": "j Hanks",
            "timezoneId": "13",
            "description": "System Administrator",
            "email": "example@d3security.com",
            "phone": "1"
        }
    ]
}