Создать пользователя

Создаёт нового пользователя.

Запрос

HTTP Запрос

POST /node/api/users

Права

manage-users

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

Параметры не требуются.

Параметры тела запроса

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

Можно создать пользователя, который будет активен определённое количество времени. для этого, нужно указать время отключения аккаунта в поле activeTo. Заметьте, что этот пользователь не будет удалён из списка пользователей. Его статус поменяется на 3 (Blocked).
Если не указать поле displayName, оно будет сгенерировано из поля login, маскируя его вторую половину символом *.
{
    "login": "example.user",
    "displayName: "exampl******",
    ...
}

Тело запроса

Пароль должен соответствовать стандартной Парольной политике.
{
    "login": "Bob",
    "password": "qwerty",
    "permissions": [
        "manage-objects",
        "manage-links"
    ]
}

Ответ

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

Некоторые опциональные поля могут быть не включены в ответ. Подробная информация о модели доступна в статье Получить всех пользователей.

Парольная политика

Новый пароль должен соответствовать стандартной Парольной политике. Если он не соответствует, запрос вернёт ошибку с первым найденным несоответствием:

{
    "code": "Internal",
    "message": "caused by Error: Password does not match policy: minimum number of characters - 32"
}

Пример

Запрос

  • Bash

  • JavaScript

  • NodeJS

  • Python

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

curl -X POST $url -u $login:$password \
    -H "Content-Type: application/json" \
    -d @- <<EOF
{
    "login": "Bob",
    "password": "qwerty",
    "permissions": [
        "manage-objects",
        "manage-links"
    ]
}
EOF
let login = <...>
let password = <...>
let saymonHostname = <...>
let path = "/node/api/users";
let auth = "Basic " + btoa(login + ":" + password);

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

let data = JSON.stringify({
    "login": "Bob",
    "password": "qwerty",
    "permissions": [
        "manage-objects",
        "manage-links"
    ]
});

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";
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({
    login: "Bob",
    password: "qwerty",
    permissions: [
        "manage-objects",
        "manage-links"
    ]
});

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

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

body = {
    "login": "Bob",
    "password": "qwerty",
    "permissions": [
        "manage-objects",
        "manage-links"
    ]
}

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

Ответ

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