user.create

The user.create command is used to create a new user.

Requires Super Administrator rights. For information on managing users see User Management.

TR50 Request


                        {
  "cmd": {
    "command": "user.create",
    "params": {
      "emailAddress": "user@example.com",
      "password": "abc123",
      "defaultOrgId": "52a1d3db169e1fd032179408",
      "firstName": "Jane",
      "lastName": "Smith",
      "company": "Acme",
      "title": "CEO",
      "officePhone": "5558675309",
      "mobilePhone": "5558675309",
      "isSuperAdmin": false,
      "isSuperOps": false
    }
  }
}
      

Request Parameters

Name

Type

Required

Description

emailAddress

String

Yes

The email address of the user.

password

String

Yes

The password of the user.

defaultOrgId

String

 

The object id of the default org the user is associated to.

firstName

String

 

The first name of the user.

lastName

String

 

The last name of the user.

company

String

 

The name of the company the user belongs to.

title

String

 

The title the user holds within the company.

officePhone

String

 

The office phone number of the user.

mobilePhone

String

 

The mobile phone number of the user.

isSuperAdmin

Boolean

 

If the user has super admin permission.

isSuperOps

Boolean

 

If the the user has super ops permission.

support

Boolean

 

Whether the user has access to the support system.

TR50 Response

If the command is sent successfully a success message is returned. Otherwise, an error and error message will be returned.


                        {
  "cmd": {
    "success": true
  }
}