Get User by User ID

LAST UPDATED: AUG 08, 2024

Retrieves detailed account information for a user identified by User ID.

Implementation	System
Command Category	Cyber Utility
Tags	`User`

Inputs

Parameter Name	Required/Optional	Description	Sample Data
UserID	Required	User unique identification	42

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

CODE

{
    "userID": "42",
    "userName": "demoUserName",
    "firstName": "demoFirstName",
    "lastName": "demoLastName",
    "fullName": "demoFullName",
    "timezoneId": "5",
    "description": "System Administrator",
    "email": "demoEmail@d3security.com",
    "phone": "6041234567",
    "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

CODE

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

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": {
    "UserID": <UserID 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.
UserID	`string`	Required	User unique identification

Sample Request

SAMPLE DATA

JSON

{
  "Username": "Admin",
  "Site": "Security Operations",
  "CommandParams": {
    "UserID": 42
  }
}

Response

Response Fields

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

Sample Response

JSON

{
    "error": "",
    "returnData": {
      "userID": "42",
      "userName": "demoUserName",
      "firstName": "demoFirstName",
      "lastName": "demoLastName",
      "fullName": "demoFullName",
      "timezoneId": "5",
      "description": "System Administrator",
      "email": "demoEmail@d3security.com",
      "phone": "6041234567",
      "role": "Admin"
  }
}