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

Отключение аккаунтов

Отключение аккаунтов

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

Отключает аккаунты одного или нескольких сотрудников организации по логину. После отключения сотрудник не сможет войти, а все его активные сессии завершаются. Логин засчитывается в disabled, только когда снят флаг активности и погашены сессии; если сессии погасить не удалось, логин попадает в failedLogins с причиной session_termination_failed — при этом аккаунт уже отключён, а запрос можно безопасно повторить. Каждый логин обрабатывается независимо: ошибка по одному не отменяет обработку остальных.

Headers

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

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

ПараметрТипОписание
logins*string[]Массив логинов сотрудников (от 1 до 25). Для отключения одного сотрудника передайте массив из одного элемента

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

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

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

ПараметрТипОписание
not_foundstringСотрудника с таким логином нет в организации
forbiddenstringНельзя отключить аккаунт с более высокой ролью, свой собственный аккаунт или аккаунт, созданный не этой организацией
session_termination_failedstringАккаунт отключён (флаг снят), но завершить его активные сессии не удалось. Повторите запрос по этому логину — сессии будут догашены
errorstringНепредвиденная ошибка при обработке этого сотрудника

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

Окно терминала
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"]
}'

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

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