Get Users Emails Grouped By Domain‎

POST /Command/EmailGroupByDomain

Get a JSON object array containing input user emails grouped by domain

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 Array	`array<string>`	Required	The input text array of user emails
Domain Array	`array<string>`	Required	The array of domain to perform grouping

Body Sample Data

application/json

JSON

{
  "Username": "Admin",
  "Site": "Security Operations",
  "CommandParams": {
    "Email Array": [
      "user_1@xxx.com",
      "user_2@xxx.de",
      "user_3@xxx.schwarz",
      "user_4@xxx.com"
    ],
    "Domain Array": [
      "iso@xxx.com",
      "iso@xxx.de",
      "iso@xxx.schwarz"
    ]
  }
}

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": "Successful",
    "contextData": [
        {
            "domain": "iso@xxx.com",
            "users": [
                {
                    "email": "user_1@xxx.com"
                },
                {
                    "email": "user_4@xxx.com"
                }
            ]
        },
        {
            "domain": "iso@xxx.de",
            "users": [
                {
                    "email": "user_2@xxx.de"
                }
            ]
        },
        {
            "domain": "iso@xxx.schwarz",
            "users": [
                {
                    "email": "user_3@xxx.de"
                }
            ]
        }
    ]
}

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