Get Users by Role
LAST UPDATED: AUG 08, 2024
Fetches users who have been assigned a specific role.
Implementation | System |
Command Category | Cyber Utility |
Tags |
|
Inputs
Parameter Name | Required/Optional | Description | Sample Data |
---|---|---|---|
Role Name | Required | The role of the queried user. | admin |
Online | Required | Only Show Online Users | Yes |
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/GetUsersByRole
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": {
"Role Name": <Role Name here>,
"Online": <Online 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. |
Role Name |
| Required | The role of the queried user. |
Online |
| Required | Only Show Online Users |
Sample Request
SAMPLE DATA
{
"Username": "Admin",
"Site": "Security Operations",
"CommandParams": {
"Role Name": "admin",
"Online": "Yes"
}
}
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. |
Sample Response
{
"error": "",
"returnData": [
{
"userID": 3,
"userName": "demoUserName",
"firstName": "demoFirstName",
"lastName": "demoLastName",
"fullName": "demoFullName",
"timezone": "Pacific Standard Time",
"timezoneId": 5,
"roleDescription": "System Administrator",
"email": "demoUserName@d3security.com",
"phone": "6041234567",
"role": "admin"
},
{
"userID": 8,
"userName": "demoUserName2",
"firstName": "demoFirstName2",
"lastName": "demoLastName2",
"fullName": "demoFullName2",
"timezone": "Pacific Standard Time",
"timezoneId": 5,
"roleDescription": "",
"email": "demoUserName2@d3security.com",
"phone": "6047654321",
"role": "2factor_Role"
}
]
}