Настройки сотрудника
Настройки сотрудника
https://gptunnel.ru/api/v1/access/setRestrictions Устанавливает настройки доступа сотрудников (вкладка «Настройки доступа» → «Настройки» в интерфейсе) — каждому логину свой набор тумблеров. Запрос принимает массив пар { login, settings } (до 25). Каждый элемент обрабатывается независимо: ошибка по одному не отменяет обработку остальных. При повторе логина берётся первое вхождение.
Тумблеры и значения
В объекте settings можно передать любой набор из пяти тумблеров (передавайте только те, что нужно изменить):
Тумблеры (settings)
| Параметр | Тип | Описание |
|---|---|---|
showBalance | string | Показывать сотруднику баланс |
webSearch | string | Веб-поиск |
imageGeneration | string | Генерация изображений |
thinkingMode | string | Режим размышления (reasoning) |
useOrgBalance | string | Списание с баланса организации |
Значение каждого тумблера — одно из трёх:
Значения
| Параметр | Тип | Описание |
|---|---|---|
allow | string | Разрешить функцию сотруднику |
forbid | string | Запретить функцию сотруднику |
default | string | Сбросить к значению по умолчанию (снять персональную настройку) |
Кто может менять
Запрос выполняется от имени роли создателя API-ключа. Менять настройки можно у сотрудников с ролью равной или ниже своей (кроме своего аккаунта):
- ключ должен принадлежать роли owner или admin (иначе весь запрос вернёт
403); - действовать можно над сотрудником с равной или более низкой ролью; сотрудника с более высокой ролью или свой собственный аккаунт изменить нельзя (по такому логину —
forbidden).
Headers
| Параметр | Тип | Описание |
|---|---|---|
Authorization* | string | API ключ |
Параметры запроса
| Параметр | Тип | Описание |
|---|---|---|
items* | object[] | Массив пар «логин + настройки» (от 1 до 25). Каждый элемент: { login, settings } |
items[].login* | string | Логин сотрудника |
items[].settings* | object | Объект тумблеров (хотя бы один), значения: allow | forbid | default |
В ответе: updated — скольким логинам применены настройки, failed — сколько с ошибкой, failedLogins — перечень логинов с ошибкой (причина и пояснение по каждому).
Причины ошибок в failedLogins:
Причины ошибок
| Параметр | Тип | Описание |
|---|---|---|
not_found | string | Сотрудника с таким логином нет в организации |
forbidden | string | Роль цели выше вашей, либо это ваш собственный аккаунт |
error | string | Непредвиденная ошибка при обработке этого сотрудника |
Пример запроса
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" } } ]}'import axios from 'axios'
const response = await axios({ method: 'POST', url: 'https://gptunnel.ru/api/v1/access/setRestrictions', headers: { Authorization: 'YOUR_API_KEY', }, data: { items: [ { login: 'ivanov', settings: { webSearch: 'forbid', imageGeneration: 'allow', showBalance: 'default', }, }, { login: 'petrov', settings: { useOrgBalance: 'forbid' } }, ], },})
console.log(response.data)import requests
response = requests.post( 'https://gptunnel.ru/api/v1/access/setRestrictions', headers={'Authorization': 'YOUR_API_KEY'}, json={ 'items': [ { 'login': 'ivanov', 'settings': { 'webSearch': 'forbid', 'imageGeneration': 'allow', 'showBalance': 'default', }, }, {'login': 'petrov', 'settings': {'useOrgBalance': 'forbid'}}, ], },)
print(response.json())Пример ответа
{ "code": 0, "updated": 1, "failed": 1, "failedLogins": [ { "login": "petrov", "reason": "not_found", "message": "Employee not found in the organization." } ]}{ "code": 3, "message": "Invalid input, check schema issues.", "details": []}{ "error": { "message": "Unauthorized", "type": "unauthorized_request_error", "param": null, "code": null }}{ "code": 7, "message": "Not allowed to perform this action for the organization."}{ "code": 13, "message": "Employee management is not available from a personal account. Use a business organization API key."}{ "code": 1, "message": "Internal server error.", "trace_id": "66a346f64dcb57627c03d596"}