Get Users by Role‎

POST /Command/GetUsersByRole

Fetches users who have been assigned a specific 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 of the queried user.
Online	`string`	Required	Only Show Online Users. (Options: “Yes“ or “No“)

Body Sample Data

application/json

JSON

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

Response

200 OK

application/json

Response Fields

Field Name	Type	Description
error	`string`	The error message if the command execution failed.
returnData	`array<JSON Object>`	The return data from the API request.

Sample Data

JSON

{
    "error": "",
    "returnData": {[
        {
            "userID": "21",
            "userName": "rjohnson",
            "firstName": "Robert",
            "lastName": "Johnson",
            "fullName": "Robert Johnson",
            "timezone": "W. Europe Standard Time",
            "timezoneId": "30",
            "description": "System Administrator",
            "email": "xxxx@d3security.com",
            "phone": "0201234xxxx"
        },
        {
            "userID": "22",
            "userName": "msmith",
            "firstName": "Mary",
            "lastName": "Smith",
            "fullName": "Mary Smith",
            "timezone": "Hawaiian Standard Time",
            "timezoneId": "3",
            "description": "System Administrator",
            "email": "xxx@d3security.com",
            "phone": "8081234xxx"
        }
    ]
}

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