Create User‎‎‎‎‎

POST /Command/CreateUser

Create a new user account

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

Body Sample Data

application/json

CODE

{
  "Username": "Admin",
  "Site": "Security Operations",
  "CommandParams": {
    "UserInfo": {
      "username": "newuser",
      "emailAddress": "xxxx@gmail.com",
      "firstName": "newfirst",
      "lastName": "newlast",
      "phoneNumber": "",
      "isActive": true,
      "roleId": "1",
      "groupIds": [
        100013,
        100011
      ],
      "siteIds": [
        100018,
        100019
      ],
      "timezoneId": "5",
      "securityLevel": 1
    }
  }
}

Response

200 OK

application/json

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 Data

CODE

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

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