Get User with User Name | docs.d3security

Last updated: Aug 08, 2024

Gets user's account information with a specified User Name

Implementation	System
Command Category	Cyber Utility
Tags	condition artifact user

Inputs

Parameter Name	Required/Optional	Description	Sample Data
User Name	Required	User's name used in his/her account	smohan_OD3

Output

Return Data

The returned result of this command. If some required parameters are not defined, this returned data could be empty. The returned result can be passed down directly to a subsequent command in playbooks.

Sample Data

JSON

Succeed

Context Data

The response data from the utility command.

Sample Data

JSON

{
    "userID": "3",
    "userName": "smohan_OD3",
    "firstName": "Sharad_O",
    "lastName": "Mohan_O",
    "fullName": "Sharad_O Mohan_O",
    "timezoneId": "5",
    "description": "System Administrator",
    "email": "",
    "phone": "",
    "role": "Admin"
}

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/GetUserByUsername

Headers

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

Request Body

JSON

{
  "Username": <Username here>,
  "Site": <Site here>,
  "CommandParams": {
    "User Name": <User Name here>
  }
}

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.
User Name	`string`	Required	User's name used in his/her account

Sample Request

Sample Data

JSON

{
  "Username": "Admin",
  "Site": "Security Operations",
  "CommandParams": {
    "User Name": "smohan_OD3"
  }
}

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

Sample Response

JSON

{
    "error": "",
    "returnData": "Succeed",
    "contextData": {
      "userID": "3",
      "userName": "smohan_OD3",
      "firstName": "Sharad_O",
      "lastName": "Mohan_O",
      "fullName": "Sharad_O Mohan_O",
      "timezoneId": "5",
      "description": "System Administrator",
      "email": "",
      "phone": "",
      "role": "Admin"
    }
}