Skip to content

Search Users

Searches users according to specified criteria.

Request

HTTP Request

POST /node/api/users/search

Permissions

manage-users

Path parameters

No parameters required.

Body parameters

See the User model.

You can use 3 options in the request body. All of them are combined with AND operator.

Request body

{
    'status': 2,
      'email': { 'contains': 'gmail' },
    'permissions': { '$regex': 'delete', '$options': 'i' }
}

Response

Field Type Description
users Array<User> An array of users that match the specified search criteria.

Example

Request

login=<...>
password=<...>
saymon_hostname=<...>
url=https://$saymon_hostname/node/api/users/search

curl -X POST $url -u $login:$password \
    -H "Content-Type: application/json" \
    -d @- <<EOF
{
    'status': 2,
    'email': { 'contains': 'gmail' },
    'permissions': { '$regex': 'delete', '$options': 'i' }
}
EOF

let login = <...>
let password = <...>
let saymonHostname = <...>
let path = "/node/api/users/search";
let auth = "Basic " + btoa(login + ":" + password);

let headers = new Headers();
headers.append("Content-Type", "application/json");
headers.append("Authorization", auth);

let data = JSON.stringify({
    'status': 2,
      'email': { 'contains': 'gmail' },
    'permissions': { '$regex': 'delete', '$options': 'i' }
});

let requestOptions = {
    method: "POST",
    headers: headers,
    body: data
};

fetch(saymonHostname + path, requestOptions)
    .then(response => response.text())
    .then(result => console.log(result))
    .catch(error => console.log("error", error));

const http = require("http");

let login = <...>
let password = <...>
let saymonHostname = <...>
let path = "/node/api/users/search";
let auth = "Basic " + Buffer.from(login + ":" + password).toString("base64");

let options = {
    "method": "POST",
    "hostname": saymonHostname,
    "headers": {
        "Authorization": auth,
        "Content-Type": "application/json"
    },
    "path": path
};

let req = http.request(options, function (res) {
    let chunks = [];

    res.on("data", function (chunk) {
        chunks.push(chunk);
    });

    res.on("end", function (chunk) {
        let body = Buffer.concat(chunks);
        console.log(body.toString());
    });

    res.on("error", function (error) {
        console.error(error);
    });
});

let data = JSON.stringify({
    'status': 2,
    'email': { 'contains': 'gmail' },
    'permissions': { '$regex': 'delete', '$options': 'i' }
});

req.write(data);
req.end();

import requests

login = <...>
password = <...>
saymon_hostname = <...>
url = "https://" + saymon_hostname + "/node/api/users/search"

body = {
    'status': 2,
    'email': { 'contains': 'gmail' },
    'permissions': { '$regex': 'delete', '$options': 'i' }
}

response = requests.request("POST", url, json=body, auth=(login, password))
print(response.text)

Response

[
    {
        "contacts": [],
        "email": "user_email@gmail.com",
        "eventFilter": [],
        "id": "5ec7aa5c6402b70c27448e5b",
        "login": "user_login",
        "objectPermissions": {
            "exclude": [
                "5e84d212866ec23538893061"
            ],
            "include": [
                "817",
                "5e84d165866ec23538892f7d",
                "5ec7aab16402b70c27448e64"
            ]
        },
        "permissions": [
            "manage-objects",
            'delete-objects',
            "manage-links",
            "manage-service-properties",
            "view-section-stat",
            "view-section-monitoring",
            "view-section-history-graph"
        ],
        "status": 2
    }
]

See Also