Get Users Emails Grouped By Domain
LAST UPDATED: AUG 08, 2024
Get a JSON object array containing input user emails grouped by domain
Implementation | System |
Command Category | Cyber Utility |
Tags | ARTIFACT EMAIL |
Inputs
Parameter Name | Required/Optional | Description | Sample Data |
---|---|---|---|
Email Array | Required | The input text array of user emails | [ "user_1@schwarz.com", "user_2@schwarz.de", "user_3@mail.schwarz", "user_4@schwarz.com" ] |
Domain Array | Required | The array of domain to perform grouping | [ |
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/EmailGroupByDomain
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 Array": [
<Email 1 here>,
<Email 2 here>,
<Email 3 here>,
<Email 4 here>
],
"Domain Array": [
<Domain 1 here>,
<Domain 2 here>,
<Domain 3 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 Array |
| Required | The input text array of user emails |
Domain Array |
| Required | The array of domain to perform grouping |
Sample Request
SAMPLE DATA
{
"Username": "Admin",
"Site": "Security Operations",
"CommandParams": {
"Email Array": [
"user_1@schwarz.com",
"user_2@schwarz.de",
"user_3@mail.schwarz",
"user_4@schwarz.com"
],
"Domain Array": [
"iso@schwarz.com",
"iso@schwarz.de",
"iso@mail.schwarz"
]
}
}
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": "Successful",
"contextData": [
{
"domain": "iso@schwarz.com",
"users": [
{
"email": "user_1@schwarz.com"
},
{
"email": "user_4@schwarz.com"
}
]
},
{
"domain": "iso@schwarz.de",
"users": [
{
"email": "user_2@schwarz.de"
}
]
},
{
"domain": "iso@mail.schwarz",
"users": [
{
"email": "user_3@schwarz.de"
}
]
}
]
}