Отключение аккаунтов
Отключение аккаунтов
POST
https://gptunnel.ru/api/v1/access/disableAccounts Отключает аккаунты одного или нескольких сотрудников организации по логину. После отключения сотрудник не сможет войти, а все его активные сессии завершаются. Логин засчитывается в disabled, только когда снят флаг активности и погашены сессии; если сессии погасить не удалось, логин попадает в failedLogins с причиной session_termination_failed — при этом аккаунт уже отключён, а запрос можно безопасно повторить. Каждый логин обрабатывается независимо: ошибка по одному не отменяет обработку остальных.
Headers
| Параметр | Тип | Описание |
|---|---|---|
Authorization* | string | API ключ |
Параметры запроса
| Параметр | Тип | Описание |
|---|---|---|
logins* | string[] | Массив логинов сотрудников (от 1 до 25). Для отключения одного сотрудника передайте массив из одного элемента |
В ответе: disabled — сколько аккаунтов отключено, failed — сколько с ошибкой, failedLogins — перечень логинов с ошибкой (причина и пояснение по каждому).
Причины ошибок в failedLogins:
Причины ошибок
| Параметр | Тип | Описание |
|---|---|---|
not_found | string | Сотрудника с таким логином нет в организации |
forbidden | string | Нельзя отключить аккаунт с более высокой ролью, свой собственный аккаунт или аккаунт, созданный не этой организацией |
session_termination_failed | string | Аккаунт отключён (флаг снят), но завершить его активные сессии не удалось. Повторите запрос по этому логину — сессии будут догашены |
error | string | Непредвиденная ошибка при обработке этого сотрудника |
Пример запроса
curl --request POST \ --url https://gptunnel.ru/api/v1/access/disableAccounts \ --header 'Authorization: YOUR_API_KEY' \ --header 'Content-Type: application/json' \ --data '{ "logins": ["ivanov", "petrov"]}'import axios from 'axios'
const response = await axios({ method: 'POST', url: 'https://gptunnel.ru/api/v1/access/disableAccounts', headers: { Authorization: 'YOUR_API_KEY', }, data: { logins: ['ivanov', 'petrov'], },})
console.log(response.data)import requests
response = requests.post( 'https://gptunnel.ru/api/v1/access/disableAccounts', headers={'Authorization': 'YOUR_API_KEY'}, json={ 'logins': ['ivanov', 'petrov'], },)
print(response.json())Пример ответа
{ "code": 0, "disabled": 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"}