Как получить и обновить токены доступа.
Чтобы получить токены доступа, нужно выполнить POST
-запрос на /authorize/auth/
. В теле запроса нужно указать полученные от нас электронную почту и пароль в составе credentials
, а также API-адрес в качестве адреса хоста.
Body
Результатом аутентификации пользователя является пара access_token
и expire_token
.
access_token – ключ (набор символов), предъявление которого является пропуском к ресурсам системы. Обращение к ним происходит с указанием в заголовках полученного access_token
.
headers = {‘ X-Forensic-Access-Token’: <access_token>}
Действие access_token ограничено во времени и регулируется настройками:
для сервисных учетных записей – OZ_SESSION_LONGLIVE_TTL
(по умолчанию 5 лет),
для всех остальных – OZ_SESSION_TTL
(по умолчанию 15 минут).
expire_token предназначен для обновления пары access_token и expire_token.
если expire_date
> текущей даты, то expire_date
сессии устанавливается в значение текущей даты + временная дельта настроек, описанных выше.
Чтобы обновить пару access_token
и expire_token
, нужно выполнить POST
-запрос на адрес authorize/refresh/
c expire_token
в теле запроса и X-Forensic-Access-Token
в заголовках.
Положительным результатом будет ответ с новой парой access_token
и expire_token
.
Предыдущая пара access_token
и expire_token
будет удалена из базы данных при первой аутентификации по новой паре access_token
и expire_token
.
Код ошибки
Сообщение об ошибке
Причина
400
Could not locate field for key_path expire_token from provided dict data
expire_token
отсутствует в теле запроса.
401
Session not found
Не существует сессии с переданным expire_token
.
403
You have not access to refresh this session
Пользователь, который делает запрос, не является владельцем сессии переданного expire_token
.