Users

Call description

This request returns a list of users that meet specified search parameters. You can search for a user using a keyword in one or more columns, e.g.:

{ "search": {"keyword": [Column_number_X, Column_number_Y]}, "skip": 0, "take": 50 }

You can search for more keywords in different columns, e.g.:

{ "search": {"keyword": [Column_number_X, Column_number_Y], "keyword2": [Column_number_Z]}, "skip": 0, "take": 50 }

Each column is identified by a number. In the type column you can search for parts of a keyword.

•This API call requires authorization; the user has to be logged in.

•Request URL: https://mspapi.eset.com/api/Search/Users

•This request is a POST call type.

Call structure

{

"search": {

"additionalProp1": [

"additionalProp2": [

"additionalProp3": [

]

"skip": 0,

"take": 0

}

Call parameters

Parameter	Description
additionalProp1	The additionalProp lets you search for a keyword string in specified columns. Type in one or more columns to search in. See the columns descriptions in the table below.
skip, take	If the requested data set is too large, you can split the response into smaller chunks. It works similarly to the paging function. The skip parameter indicates how many entries should be skipped and the take parameter indicates how many entries should be listed. The take value must be from 1 to 100. For example: •to list the first 20 entries, set up: "skip": 0, "take": 20 •to list the second 20 entries (from 21 to 40), set up: "skip": 20, "take": 20

Parameter

Description

additionalProp1

The additionalProp lets you search for a keyword string in specified columns. Type in one or more columns to search in. See the columns descriptions in the table below.

skip, take

If the requested data set is too large, you can split the response into smaller chunks. It works similarly to the paging function. The skip parameter indicates how many entries should be skipped and the take parameter indicates how many entries should be listed. The take value must be from 1 to 100.

For example:

•to list the first 20 entries, set up: "skip": 0, "take": 20

•to list the second 20 entries (from 21 to 40), set up: "skip": 20, "take": 20

List of columns

Search by	Column number	Keyword example	Description
User public id	0	“0D30A7B5-6E01-40C8-9EC4-F056329017C7”
First name	2	“MspTest”
Last name	3	“SurnameTest”
Name	4	“MspTest SurnameTest”	Name is “FirstName + LastName”
User status	5	“1”	•Active = 1 •Waiting for activation / Activation link expired= 2
Phone number	7	“+421 000 235 567”
Email	8	"test@eset.com", “@eset.com”
Description	10	“Distributor”
User created on	11	"2015-02-25"
User modified on	12	"2016-02-17"
Country code	14	“USA”	Three-letter code identifier for the country. Use only codes from the list.
Permission type ID	18	“1”	•1 - Write, •2 - Read, •3 - NoAccess

Response structure

The response contains data in the JSON format.

The response contains basic data about all users that match the search conditions.

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.

List of error codes

˄˅