Get All Users with Specific Role‎

POST /Command/GetAllUserOfARole

Get a list of users who are assigned a particular role.

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.
Role Name	`string`	Required	The Role Name to get all users under it

Body Sample Data

application/json

JSON

{
  "Username": "Admin",
  "Site": "Security Operations",
  "CommandParams": {
    "Role Name": "admin"
  }
}

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	`JSON Array`	The return data from the API request.

Sample Data

JSON

{
    "error": "",
    "returnData": "Succeed",
    "contextData": [
      {
          "userID": "1",
          "userName": "admin",
          "firstName": "admin",
          "lastName": "user",
          "fullName": "admin user",
          "timezoneId": "5",
          "description": "System Administrator",
          "email": "xxxx@d3security.com",
          "phone": ""
      },
      {
          "userID": "3",
          "userName": "smohan_OD3",
          "firstName": "Sharad_O",
          "lastName": "Mohan_O",
          "fullName": "Sharad_O Mohan_O",
          "timezoneId": "5",
          "description": "System Administrator",
          "email": "",
          "phone": ""
      }
  ]
}

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