Получить пользователя по ID

Возвращает пользователя с заданным ID.

Запрос

HTTP Запрос

GET /node/api/users/:id

Права

Пользователь должен иметь права manage-users, чтобы получить все возможные поля. Подробнее смотрите в разделе Ответ.

Если у пользователя нет прав manage-users, ответ будет содержать только поля id и login.

Для пользователей без прав manage-users, поля login будет содержать значение поля displayName.
[
    {
        "id": "5716383a15ebe5891125d6ca",
        "login": "exampl******"
    },
    {
        "id": "578cf86daa6ca8853bec66df",
        "login": "manually-set-display-name"
    },
    ...
]

Параметры пути

Параметр Тип Описание

id

String
обязательный

ID пользователя

Тело запроса

Тело запроса пустое.

Ответ

Возвращает пользователя с заданным ID. Подробная информация о модели доступна в статье Пользователь.

Пример

Запрос

  • Bash

  • JavaScript

  • NodeJS

  • Python

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

curl -X GET $url -u $login:$password
let login = <...>
let password = <...>
let saymonHostname = <...>
let userId = <...>
let path = "/node/api/users/" + userId;
let auth = "Basic " + btoa(login + ":" + password);

let headers = new Headers();
headers.append("Authorization", auth);

let requestOptions = {
    method: "GET",
    headers: headers
};

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 userId = <...>
let path = "/node/api/users/" + userId;
let auth = "Basic " + Buffer.from(login + ":" + password).toString("base64");

let options = {
    "method": "GET",
    "hostname": saymonHostname,
    "headers": {
        "Authorization": auth
    },
    "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);
    });
});

req.end();
import requests

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

response = requests.request("GET", url, auth=(login, password))
print(response.text)

Ответ

{
    "login": "Bob",
    "status": 2,
    "eventFilter": [],
    "permissions": [
        "manage-links"
    ],
    "contacts": [],
    "id": "5e78c51788c61a1fbf34b673"
}