Get User by Full Name‎ | docs.d3security

POST /Command/GetUserByFullName

Finds a user by matching the provided first and last names.

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.
First Name	`string`	Required	First name of a user.
Last Name	`string`	Required	Last name of a user.

Body Sample Data

application/json

JSON

{
  "Username": "Admin",
  "Site": "Security Operations",
  "CommandParams": {
    "First Name": "John",
    "Last Name": "Doe"
  }
}

Response

200 OK

application/json

Response Fields

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

Sample Data

JSON

{
    "error": "",
    "returnData": {
      "userID": 588,
      "userName": "rwxxx",
      "firstName": "xxxx",
      "lastName": "Wang",
      "fullName": "xxxx Wang",
      "timezone": "Pacific Standard Time",
      "timezoneId": 5,
      "roleDescription": "System Administrator",
      "email": "xxxx@d3security.com",
      "phone": "",
      "role": "admin"
  }
}

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