Режимы аутентификации#

Проверка состояния#

Метод

GET https://login.company.com/blitz/api/v3/users/{subjectId}/auth

Проверка состояния следующих режимов аутентификации учетной записи subjectId:

  • наличие включенной двухфакторной аутентификации;

  • наличие установленного признака необходимости смены пароля;

  • наличие временного запрета по входу с использованием определенного метода входа.

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

Возвращает

  • requiredFactor признак включенной двухфакторной аутентификации. Может принимать следующие значения:

    • отсутствует, 0 или 1 - выключен,

    • 2 - включен (требуется 2-й фактор аутентификации);

  • needPasswordChange признак необходимости смены пароля при входе;

  • methodsLocked список заблокированных методов аутентификации. Пользователь не может использовать данные методы входа, но может использовать остальные.

Пример

GET /blitz/api/v3/users/d2580c98-e584-4aad-a591-97a8cf45cd2a/auth HTTP/1.1
Authorization: Bearer cNwIXatB0wk5ZHO0xG5kxuuLubesWcb_yPPqLOFWDuwzMDc0Nz
Cache-Control: no-cache

{
    "requiredFactor": 2,
    "needPasswordChange": true,
    "methodsLocked": ["password"]
}

Изменение режимов аутентификации#

POST https://login.company.com/blitz/api/v3/users/{subjectId}/auth

Изменения режимов аутентификации пользователя.

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

Заголовки

В пользовательском режиме необходимо передать заголовки с IP‑адресом пользователя и User-Agent.

Тело запроса

Может содержать параметры:

  • requiredFactor признак включенной двухфакторной аутентификации. Значения:

    • null выключен,

    • 2 включен (требуется 2-й фактор аутентификации);

  • needPasswordChange признак необходимости смены пароля при входе – допустима только передача значения true;

  • methodsLocked список заблокированных методов аутентификации. Пользователь не может использовать данные методы входа, но может использовать остальные. В настоящий момент Blitz Identity Provider поддерживает только блокирование использования парольного входа (password).

Пример

POST /blitz/api/v3/users/d2580c98-e584-4aad-a591-97a8cf45cd2a/auth HTTP/1.1
Authorization: Bearer cNwIXatB0wk5ZHO0xG5kxuuLubesWcb_yPPqLOFWDuwzMDc0Nz
X-Forwarded-For: 200.200.100.100
User-Agent: Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_5)…
Content-Type: application/json

{
    "requiredFactor": 2,
    "needPasswordChange": true,
    "methodsLocked": ["password"]
}

{
    "requiredFactor": 2,
    "needPasswordChange": true,
    "methodsLocked": ["password"]
}
HTTP 400 Bad Request: у пользователя не настроен ни один метод для второго фактора аутентификации#
{
    "type": "input_error",
    "error": "wrong_values",
    "errors": [
        {
            "type": "input_error",
            "error": "has_not_sf_methods",
            "desc": "User 'd2580c98-e584-4aad-a591-97a8cf45cd2a' has not any second factor method",
            "pos": "requiredFactor"
        }
    ]
}