Get Email Addresses' Reputation

Last updated: Aug 07, 2024

This command processes a given list of email addresses and evaluates the risk level associated with each one. The output is a detailed list of email addresses paired with their respective risk levels.

Implementation	System
Command Category	Cyber Utility
Tags	artifact condition reputation email

Inputs

Parameter Name	Required/Optional	Description	Sample Data
List of Email Addresses	Required	An array of string containing multiple Email addresses	JSON `[ "jack@d3security.com", "tom@d3security.com", "amy@d3security.com", "jason@d3security.com", "jeff@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

[
    {
        "email": "jack@d3security.com",
        "risklevel": "Low"
    },
    {
        "email": "tom@d3security.com",
        "risklevel": "Medium"
    },
    {
        "email": "amy@d3security.com",
        "risklevel": "High"
    },
    {
        "email": "jason@d3security.com",
        "risklevel": "Zero"
    },
    {
        "email": "jeff@d3security.com",
        "risklevel": "N/A"
    }
]

Key Fields

Important key and value pairs extracted from Raw Data.

Sample Data

JSON

{
    "Output": [
      {
          "email": "jack@d3security.com",
          "risklevel": "Low"
      },
      {
          "email": "tom@d3security.com",
          "risklevel": "Medium"
      },
      {
          "email": "amy@d3security.com",
          "risklevel": "High"
      },
      {
          "email": "jason@d3security.com",
          "risklevel": "Zero"
      },
      {
          "email": "jeff@d3security.com",
          "risklevel": "N/A"
      }
    ]
}

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

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": {
    "List of Email Addresses": [
      <Email Address 1 here>,
      <Email Address 2 here>,
      <Email Address 3 here>,
      <Email Address 4 here>,
      <Email Address 5 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.
List of Email Addresses	`Array<string>`	Required	A string array containing multiple Email addresses

Sample Request

Sample Data

JSON

{
  "Username": "Admin",
  "Site": "Security Operations",
  "CommandParams": {
    "List of Email Addresses": [
      "jack@d3security.com",
      "tom@d3security.com",
      "amy@d3security.com",
      "jason@d3security.com",
      "jeff@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<string>`	The context data from the API request.
keyFields	`JSON Object`	The key fields from the API request.

Sample Response

JSON

{
    "error": "",
    "returnData": "Succeed",
    "contextData": [
        {
            "email": "jack@d3security.com",
            "risklevel": "Low"
        },
        {
            "email": "tom@d3security.com",
            "risklevel": "Medium"
        },
        {
            "email": "amy@d3security.com",
            "risklevel": "High"
        },
        {
            "email": "jason@d3security.com",
            "risklevel": "Zero"
        },
        {
            "email": "jeff@d3security.com",
            "risklevel": "N/A"
        }
    ]
    "keyFields": {
        "Output": [
            {
                "email": "jack@d3security.com",
                "risklevel": "N/A"
            },
            {
                "email": "tom@d3security.com",
                "risklevel": "N/A"
            },
            {
                "email": "amy@d3security.com",
                "risklevel": "N/A"
            },
            {
                "email": "jason@d3security.com",
                "risklevel": "N/A"
            },
            {
                "email": "jeff@d3security.com",
                "risklevel": "N/A"
            }
        ]
    }
}