Create
Call description
This request returns detailed information about the user you are creating. The information includes the firstName, lastName, email and information about the company that the user belongs to (including companyId, country, and timeZone). You can only create a user under your (parent) company.
The following properties are set to default values when creating a user:
•Two-factor authentication: "twoFactorEnabled": false
•Status is set to 1 (active): "status": 1
•Your parent company ID is inherited form the parent user.
•Time zone (timeZone) is set during the user's activation.
•This API call requires authorization; the user has to be logged in.
•Request URL: https://mspapi.eset.com/api/User/Create
•This request is a POST call type.
Call structure
{
"firstName": "string",
"lastName": "string",
"description": "string",
"email": "string",
"phone": "string",
"countryCode": "string",
"permissionType": "Write",
"specificPermissions": {
"additionalProp1": 0,
"additionalProp2": 0,
"additionalProp3": 0
}
}
Call parameters
Parameter |
Description |
|---|---|
firstName |
The user's first name. The first name does not need to be unique. Mandatory input parameter. A proper value must be set. |
lastName |
The user's surname. The surname does not need to be unique. Mandatory input parameter. A proper value must be set. |
description |
Description field. |
Email address of the user. Mandatory input parameter. A proper value must be set. |
|
phone |
User's phone number. |
countryCode |
Three-letter code identifier for the country. Use only codes from the list. Mandatory input parameter. A proper value must be set. |
permissionType |
Set up the permission for the new user. The available permissionType values are: •1 (write to parent) •2 (read to parent) •3 (no access to parent). Mandatory input parameter. A proper value must be set. |
specificPermissions, additionalProp1 |
Setting specificPermissions is optional and can be used only if the permissionType of the current user in relation to the user's parent company is set to 2 or 3. SpecificPermissions contains the companyID and permissions type: •1 (write to company) •2 (read to company). You can set up multiple specificPermissions in the request; see the call structure for more information. |
Response structure
The response contains data in the JSON format.
If the request is successful, you will obtain a response with the requested information; similar to GetUserDetails, of the new user.
Troubleshooting
ESET MSP Administrator 2 API uses standardized error codes. If you are getting errors or unexpected responses, see the Troubleshooting API for common problems and the list of error codes.