Get All Users with Specific Role

LAST UPDATED: AUG 07, 2024

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

Implementation	System
Command Category	Cyber Utility
Tags	`User`

Inputs

Parameter Name	Required/Optional	Description	Sample Data
Role Name	Required	The Role Name to get all users under it	admin

Output

Context Data

The response data from the utility command.

SAMPLE DATA

JSON

[
    {
        "userID": "1",
        "userName": "admin",
        "firstName": "admin",
        "lastName": "user",
        "fullName": "admin user",
        "timezoneId": "5",
        "description": "System Administrator",
        "email": "demoEmail@d3security.com",
        "phone": "6031234567"
    }
]

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

CODE

https:/{base_url}/{api_namespace}/api/Command/GetAllUserOfARole

Headers

Please refer to the page Webhook Configuration Guide - Authentication Method: API Keys for more details.

Request Body

JSON

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

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

Sample Request

SAMPLE DATA

JSON

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

Response

Response Fields

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

Sample Response

JSON

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