Контрольные вопросы#

Внимание

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

Проверка наличия вопроса#

Метод

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

Проверка наличия у пользователя контрольного вопроса.

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

Возвращает

  • Если контрольный вопрос задан - текст контрольного вопроса.

  • Если контрольный вопрос не задан - 404 Not Found.

Пример

GET /api/v3/users/d258..d2a/secQsn HTTP/1.1
Authorization: Bearer cNwI..c0Nz
Cache-Control: no-cache

{
    "question": "Как звали вашего первого питомца"
}

Проверка ответа#

Метод

POST /api/v3/users/{subjectId}/secQsn/check

Проверка правильности ответа на контрольный вопрос.

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

Тело запроса

Контрольный вопрос (question) и ответ на него (answer).

Возвращает

  • В случае успешной проверки вопроса и ответа - 204 No Content.

  • В противном случае - 400 Bad request.

Пример

POST /api/v3/users/d258..d2a/secQsn/check HTTP/1.1
Authorization: Bearer cNw..Dc0Nz
Content-Type: application/json
X-Forwarded-For: 200.200.100.100
User-Agent: Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_5)…

{
    "question": "Как звали вашего первого питомца",
    "answer": "Тигр"
}
Не совпал контрольный вопрос#
{
    "type": "process_error",
    "error": "wrong_security_answer",
    "desc": "security question not match"
}
Не совпал ответ на контрольный вопрос#
{
    "type": "process_error",
    "error": "wrong_security_answer",
    "desc": "security answer not match"
}
Контрольный вопрос у пользователя не установлен#
{
    "type": "process_error",
    "error": "wrong_security_answer",
    "desc": "security question not found"
}

Установка или изменение вопроса#

Метод

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

Установка или изменение контрольного вопроса пользователя.

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

Тело запроса

Контрольный вопрос (question) и ответ на него (answer).

Возвращает

В случае успешной установки контрольного вопроса - 204 No Content.

Пример запроса#
POST /api/v3/users/d2580..d2a/secQsn HTTP/1.1
Authorization: Bearer cNwI..c0Nz
Content-Type: application/json
X-Forwarded-For: 200.200.100.100
User-Agent: Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_5)…

{
    "question": "Как звали вашего первого питомца",
    "answer": "Тигр"
}

Удаление вопроса#

Метод

DELETE /api/v3/users/{subjectId}/secQsn

Удаление контрольного вопроса из учетной записи пользователя.

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

Возвращает

При успешном выполнении - 204 No Content.

Пример запроса#
DELETE /api/v3/users/d258..d2a/secQsn HTTP/1.1
Authorization: Bearer cNwIX..c0Nz
X-Forwarded-For: 200.200.100.100
User-Agent: Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_5)…