> ## Documentation Index
> Fetch the complete documentation index at: https://docs.arzguard.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Определить пользователя по сессии

> Ищет пользователя по идентификатору сессии или значению cookie запоминания входа.

Ищет пользователя по идентификатору сессии или значению cookie запоминания входа.

Передайте хотя бы одно из `session_id` или `remember_cookie`; оба поля необязательны по отдельности. Сначала проверяется сессия, затем cookie. При отсутствии подходящего значения ответ содержит `success=false` без `user`. Успешно найденная сессия может соответствовать гостю: проверяйте `user.user_id`, а не только `success`. Метод не создаёт новую сессию.

## Доступ

Передавайте `XF-Api-Key` в заголовке каждого запроса. [Типы ключей и выбор пользователя](https://docs.arzguard.com/guard-forum/authentication.md).

Требуемые scopes: `auth`. Все перечисленные разрешения нужны одновременно.

Метод доступен только с Super key.

## Параметры

**XF-Api-Key** `string` *required*

Секретный API-ключ. В примерах ключ берётся из серверной переменной `$FORUM_API_KEY`.

Тело запроса: `application/x-www-form-urlencoded`. Вложенные значения передавайте в форме с квадратными скобками в имени поля.

**session\_id** `string`

Секретный идентификатор действующей публичной сессии XenForo. Достаточно этого поля или `remember_cookie`.

**remember\_cookie** `string`

Секретное значение cookie «запомнить меня». Достаточно этого поля или `session_id`.

**session\_ip\_limit** `string`

Необязательный IP для сверки с адресом сессии. Для вошедшего пользователя проверяется подсеть /24 в IPv4 или /64 в IPv6; пустое значение не ограничивает сессию.

## Ответ

HTTP `200`, JSON. [Схемы объектов и условные поля](https://docs.arzguard.com/guard-forum/models.md).

**success** `boolean`

Установлено ли соответствие действующей сессии или cookie. При `false` поле `user` отсутствует.

**user** `User`

Объект найденного пользователя. При проверке сессии может представлять гостя; при `success=false` отсутствует.

Ошибки возвращаются в общей структуре `errors`. Обрабатывайте поле `code`; текст `message` может меняться или переводиться. [Формат ошибок](https://docs.arzguard.com/guard-forum/requests-and-errors.md).

```bash cURL theme={null}
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'
```

```json 200 · условный пример theme={null}
{
  "success": false
}
```

Примеры сокращены и содержат только условные значения. Состав полей объектов зависит от прав, контекста и установленных дополнений.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.