curl --request POST \
--header "XF-Api-Key: $FORUM_API_KEY" \
--header 'Accept: application/json' \
--data-urlencode 'group=8' \
'https://forum.arzguard.com/api/promote/123/'
{
"success": true,
"groups": {
"8": "Условная группа"
}
}
Повышение и снятие
Повысить пользователя
Заменяет управляемые инициатором дополнительные группы одной выбранной группой.
POST
/
api
/
promote
/
{user_id}
/
curl --request POST \
--header "XF-Api-Key: $FORUM_API_KEY" \
--header 'Accept: application/json' \
--data-urlencode 'group=8' \
'https://forum.arzguard.com/api/promote/123/'
{
"success": true,
"groups": {
"8": "Условная группа"
}
}
Назначает выбранную дополнительную группу и снимает остальные дополнительные группы из управляемого инициатором набора.
Все ID и данные в примерах условные.
Форматы тела запроса и общая обработка ошибок описаны в разделе «Запросы и ошибки».
Доступ
Требуется scopeuser:promote, право пользователя general/promoteAllow и хотя бы одна группа, которой он может управлять. Эти собственные проверки выполняются и при запросе обхода стандартных прав XenForo.
string
required
Обязательный ключ API XenForo. Тип ключа и пользовательский контекст описаны в разделе «Авторизация».
Параметры
integer
required
Положительный ID существующего форумного пользователя.
integer
required
Положительный ID одной группы из доступного инициатору набора. Передаётся формой
application/x-www-form-urlencoded.Результат
boolean
При успешном сохранении равно
true.object | array
ID и названия всех оставшихся дополнительных групп пользователя после операции. Если дополнительных групп не осталось, PHP сериализует пустой набор как
[].Поведение
Доступные группы определяются настройкойgroups_that_can_promote: она должна содержать основную или одну из дополнительных групп инициатора.
Изменение отклоняется, если целевой пользователь не существует, его основная или дополнительная группа имеет block_promote либо настройка groups_that_cant_promote целевых групп запрещает действия группам инициатора.
Посторонние дополнительные группы и основная группа сохраняются. После сохранения пересчитываются группа оформления, комбинация разрешений и связи групп. Пустая или нулевая group не принимается; группа вне доступного набора также отклоняется. Проверка и сохранение не предоставляют клиенту условного атомарного обновления.
При ответе с
user установленное расширение может вернуть user_title: true для непустого пользовательского титула. Это известное отличие текущей реализации от обычной строки титула.FORUM_API_KEY — заранее настроенная переменная окружения; действующий ключ в документации не приводится.
curl --request POST \
--header "XF-Api-Key: $FORUM_API_KEY" \
--header 'Accept: application/json' \
--data-urlencode 'group=8' \
'https://forum.arzguard.com/api/promote/123/'
{
"success": true,
"groups": {
"8": "Условная группа"
}
}