Перейти к содержимому

Настройки сотрудника

Настройки сотрудника

POST https://gptunnel.ru/api/v1/access/setRestrictions

Устанавливает настройки доступа сотрудников (вкладка «Настройки доступа» → «Настройки» в интерфейсе) — каждому логину свой набор тумблеров. Запрос принимает массив пар { login, settings } (до 25). Каждый элемент обрабатывается независимо: ошибка по одному не отменяет обработку остальных. При повторе логина берётся первое вхождение.

Тумблеры и значения

В объекте settings можно передать любой набор из пяти тумблеров (передавайте только те, что нужно изменить):

Тумблеры (settings)

ПараметрТипОписание
showBalancestringПоказывать сотруднику баланс
webSearchstringВеб-поиск
imageGenerationstringГенерация изображений
thinkingModestringРежим размышления (reasoning)
useOrgBalancestringСписание с баланса организации

Значение каждого тумблера — одно из трёх:

Значения

ПараметрТипОписание
allowstringРазрешить функцию сотруднику
forbidstringЗапретить функцию сотруднику
defaultstringСбросить к значению по умолчанию (снять персональную настройку)

Кто может менять

Запрос выполняется от имени роли создателя API-ключа. Менять настройки можно у сотрудников с ролью равной или ниже своей (кроме своего аккаунта):

  • ключ должен принадлежать роли owner или admin (иначе весь запрос вернёт 403);
  • действовать можно над сотрудником с равной или более низкой ролью; сотрудника с более высокой ролью или свой собственный аккаунт изменить нельзя (по такому логину — forbidden).

Headers

ПараметрТипОписание
Authorization*stringAPI ключ

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

ПараметрТипОписание
items*object[]Массив пар «логин + настройки» (от 1 до 25). Каждый элемент: { login, settings }
items[].login*stringЛогин сотрудника
items[].settings*objectОбъект тумблеров (хотя бы один), значения: allow | forbid | default

В ответе: updated — скольким логинам применены настройки, failed — сколько с ошибкой, failedLogins — перечень логинов с ошибкой (причина и пояснение по каждому).

Причины ошибок в failedLogins:

Причины ошибок

ПараметрТипОписание
not_foundstringСотрудника с таким логином нет в организации
forbiddenstringРоль цели выше вашей, либо это ваш собственный аккаунт
errorstringНепредвиденная ошибка при обработке этого сотрудника

Пример запроса

Окно терминала
curl --request POST \
--url https://gptunnel.ru/api/v1/access/setRestrictions \
--header 'Authorization: YOUR_API_KEY' \
--header 'Content-Type: application/json' \
--data '{
"items": [
{
"login": "ivanov",
"settings": {
"webSearch": "forbid",
"imageGeneration": "allow",
"showBalance": "default"
}
},
{
"login": "petrov",
"settings": { "useOrgBalance": "forbid" }
}
]
}'

Пример ответа

{
"code": 0,
"updated": 1,
"failed": 1,
"failedLogins": [
{
"login": "petrov",
"reason": "not_found",
"message": "Employee not found in the organization."
}
]
}