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 |
|
Inputs
Parameter Name | Required/Optional | Description | Sample Data |
---|---|---|---|
Email Address | Required | User's Email address used in his/her account | example@d3security.com |
Output
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
{
"Username": <Username here>,
"Site": <Site here>,
"CommandParams": {
"Email Address": <Email Address here>
}
}
Body Parameters
Parameter Name | Type | Required/Optional | Description |
---|---|---|---|
Username |
| Required | The username of your D3 SOAR account. |
Site |
| Required | The D3 SOAR site to run the remote command. |
Email Address |
| Required | User's Email address used in his/her account |
Sample Request
SAMPLE DATA
{
"Username": "Admin",
"Site": "Security Operations",
"CommandParams": {
"Email Address": "example@d3security.com"
}
}
Response
Response Fields
Field Name | Type | Description |
---|---|---|
error |
| The error message if the API request has failed. |
returnData |
| The return data from the API request. |
contextData |
| The context data from the API request. |
Sample Response
{
"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"
}
]
}