Get User by ID

Returns a user with the specified ID.

Request

HTTP Request

GET /node/api/users/:id

Permissions

A user needs manage-users permissions to get all possible fields. See the Response section for more information.

If a user doesn’t have manage-users permissions, the response will contain only id and login fields.

For users without manage-users permissions, a login field will contain a displayName field instead. 
[
    {
        "id": "5716383a15ebe5891125d6ca",
        "login": "exampl******"
    },
    {
        "id": "578cf86daa6ca8853bec66df",
        "login": "manually-set-display-name"
    },
    ...
]

Path parameters

Parameter Type Description

id

String
required

User’s ID

Request body

The request body is empty.

Response

Returns a user with the specified ID. See the User model for a list of all returned fields.

Example

Request

  • 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)

Response

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

See Also