Get User with Email Address‎

POST /Command/GetUserByEmailAddress

Gets user's account information with a specified Email Address

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

Body Sample Data

application/json

JSON

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

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

JSON

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

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