Состояние учетной записи#

Внимание

API-запросы отправляются на адрес https://login.company.com/<context>/<url>, где context — заданный относительный путь до сервисов Blitz Identity Provider, url - адрес метода, приведенный в настоящем разделе. По умолчанию API-запросы отправляются на https://login.company.com/blitz/<url>.

Проверка состояния учетной записи#

Метод

GET /api/v3/users/{subjectId}/state

Проверка состояния учетной записи:

наличие блокировки по причине неактивности;
наличие запрета на блокировку по причине неактивности.

Необходимые разрешения: blitz_api_usec или blitz_api_sys_usec.

Примеры

Запрос

GET /api/v3/users/d2580..d2a/state HTTP/1.1
Authorization: Bearer cNw..0Nz
Cache-Control: no-cache

Ответы

Состояние учетной записи еще не инициализировано (учетная запись только создана или еще не использовалась до входа с момента появления функции)#

{
  "name": "initial"
}

Учетная запись активна#

{
  "name": "active",
  "checkedOn": 1688106755
}

Примечание

В параметре checkedOn хранится временная отметка последней проверки состояния.

Учетная запись заблокирована по причине длительной неактивности#

{
  "name": "inactivityLock",
  "on": 1688106646
}

Примечание

В параметре on хранится время блокировки.

Учетная запись находится в списке исключений и не может быть заблокирована по причине неактивности до наступления даты из параметра till#

{
  "name": "untouchable",
  "till": 1689106755
}

Примечание

Если параметр till отсутствует, то учетная запись не может быть вообще заблокирована по причине неактивности.

Изменение состояния учетной записи#

Метод

POST /api/v3/users/{subjectId}/state

Изменение состояния учетной записи пользователя.

Необходимые разрешения: blitz_api_sys_usec_chg.

Тело запроса

Возможные параметры:

name - назначаемое состояние. Можно назначить только состояние untouchable;
till - необязательный параметр, в котором можно указать время, до которого учетной записи назначается состояние untouchable. Для отмены состояния untouchable можно назначить параметру till текущее время.

Возвращает

В случае успешного вызова HTTP 204 No Content.

Пример

Запрос#

POST /api/v3/users/d2580..cd2a/state HTTP/1.1
Authorization: Bearer cNwI..c0Nz
Content-Type: application/json

{
    "name": "untouchable",
    "till": 1689106755
}