curl --request POST 'https://forum.arzguard.com/api/auth/from-session' \
--header "XF-Api-Key: $FORUM_API_KEY" \
--header 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode 'session_id=EXAMPLE_SESSION_ID'
{
"success": false
}
Аутентификация
Определить пользователя по сессии
Ищет пользователя по идентификатору сессии или значению cookie запоминания входа.
POST
/
api
/
auth
/
from-session
curl --request POST 'https://forum.arzguard.com/api/auth/from-session' \
--header "XF-Api-Key: $FORUM_API_KEY" \
--header 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode 'session_id=EXAMPLE_SESSION_ID'
{
"success": false
}
Ищет пользователя по идентификатору сессии или значению cookie запоминания входа.
Передайте хотя бы одно из
Тело запроса:
Ошибки возвращаются в общей структуре
Примеры сокращены и содержат только условные значения. Состав полей объектов зависит от прав, контекста и установленных дополнений.
session_id или remember_cookie; оба поля необязательны по отдельности. Сначала проверяется сессия, затем cookie. При отсутствии подходящего значения ответ содержит success=false без user. Успешно найденная сессия может соответствовать гостю: проверяйте user.user_id, а не только success. Метод не создаёт новую сессию.
Доступ
ПередавайтеXF-Api-Key в заголовке каждого запроса. Типы ключей и выбор пользователя.
Требуемые scopes: auth. Все перечисленные разрешения нужны одновременно.
Метод доступен только с Super key.
Параметры
string
required
Секретный API-ключ. В примерах ключ берётся из серверной переменной
$FORUM_API_KEY.application/x-www-form-urlencoded. Вложенные значения передавайте в форме с квадратными скобками в имени поля.
string
Секретный идентификатор действующей публичной сессии XenForo. Достаточно этого поля или
remember_cookie.string
Секретное значение cookie «запомнить меня». Достаточно этого поля или
session_id.string
Необязательный IP для сверки с адресом сессии. Для вошедшего пользователя проверяется подсеть /24 в IPv4 или /64 в IPv6; пустое значение не ограничивает сессию.
Ответ
HTTP200, JSON. Схемы объектов и условные поля.
boolean
Установлено ли соответствие действующей сессии или cookie. При
false поле user отсутствует.User
Объект найденного пользователя. При проверке сессии может представлять гостя; при
success=false отсутствует.errors. Обрабатывайте поле code; текст message может меняться или переводиться. Формат ошибок.
curl --request POST 'https://forum.arzguard.com/api/auth/from-session' \
--header "XF-Api-Key: $FORUM_API_KEY" \
--header 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode 'session_id=EXAMPLE_SESSION_ID'
{
"success": false
}