> ## 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.

# Проверить логин и пароль

> Проверяет учётные данные и возвращает пользователя при успешной проверке.

Проверяет учётные данные и возвращает пользователя при успешной проверке.

Нужен Super key со scope `auth`. Метод проверяет пароль, но не создаёт браузерную сессию и не является OAuth-обменом. Для защиты от перебора передавайте реальный IP клиента в `limit_ip`. Логин и пароль отправляйте в теле формы.

## Доступ

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

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

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

## Параметры

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

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

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

**login** `string` *required*

Имя пользователя или email для проверки входа. Передавайте в теле запроса.

**password** `string` *required*

Проверяемый пароль. Передавайте в теле запроса; API-ключ его не заменяет.

**limit\_ip** `string`

IP клиента для проверки входа и ограничения перебора. Это адрес клиента, а не сервера интеграции.

## Ответ

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

**user** `User`

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

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

```bash cURL theme={null}
curl --request POST 'https://forum.arzguard.com/api/auth/' \
  --header "XF-Api-Key: $FORUM_API_KEY" \
  --header 'Content-Type: application/x-www-form-urlencoded' \
  --data-urlencode 'login=example_user' \
  --data-urlencode 'password=EXAMPLE_PASSWORD'
```

```json 200 · условный пример theme={null}
{
  "user": {
    "user_id": 42,
    "username": "example_user"
  }
}
```

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


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