Create User‎ | docs.d3security

Last updated: Aug 12, 2024

Enables the creation of a new user account.

Implementation	System
Command Category	System Utility
Tags	User

Inputs

Parameter Name	Required/Optional	Description	Sample Data
UserInfo	Required	The users information for creating users	{ "username": "demoUsername", "emailAddress": "demo@d3security.com", "firstName": "demoFirstname", "lastName": "demoLastname", "phoneNumber": "6041234567", "isActive": true, "roleId": "1", "groupIds": [ 100013, 100011 ], "siteIds": [ 100018, 100019 ], "timezoneId": "5", "securityLevel": 1 }

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

Successful

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

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": {
    "UserInfo": "<UserInfo 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.
UserInfo	`JSON Object`	Required	The users information for creating users

Sample Request

Sample Data

JSON

{
  "Username": "Admin",
  "Site": "Security Operations",
  "CommandParams": {
    "UserInfo": {
      "username": "demoUsername",
      "emailAddress": "demo@d3security.com",
      "firstName": "demoFirstName",
      "lastName": "demoLastName",
      "phoneNumber": "6041234567",
      "isActive": true,
      "roleId": "1",
      "groupIds": [
        100013,
        100011
      ],
      "siteIds": [
        100018,
        100019
      ],
      "timezoneId": "5",
      "securityLevel": 1
    }
  }
}

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.

Sample Response

JSON

{
    "error": "",
    "returnData": "Successful"
}