Управление пользователями Xbox Live

  • Статья

Запрос

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

Метод Универсальный код ресурса (URI) запроса
GET /ext/user
PUT /ext/user

Параметры URI

  • Нет

Заголовки запроса

  • Нет

Текст запроса

Вызовы PUT должны включать массив JSON со следующей структурой:

  • Пользователи
    • AutoSignIn (необязательный): логический параметр, который отключает или включает автоматический вход для учетной записи, указанной в EmailAddress или UserId.
    • EmailAddress (необязательный — указывается, если UserId не предоставлен, но не для спонсированного пользователя): электронный адрес, указывающий пользователя, которого требуется изменить, добавить или удалить.
    • Password (необязательный — указывается, если пользователь в данный момент не вошел в консоль): пароль, используемый для добавления нового пользователя на консоль.
    • SignedIn (необязательный): логический параметр, указывающий, следует ли выполнить вход или выход для предоставленной учетной записи.
    • UserId (необязательный — указывается, если EmailAddress не предоставлен, но не для спонсированного пользователя): UserId, указывающий пользователя, которого требуется изменить, добавить или удалить.
    • SponsoredUser (необязательный): логический параметр, указывающий, следует ли добавить спонсированного пользователя.
    • Delete (необязательный): логическое значение, указывающее удаление этого пользователя из консоли.

Ответ

Текст ответа

Вызовы GET возвращают массив JSON со следующими свойствами.

  • Пользователи
    • AutoSignIn (необязательный)
    • EmailAddress (необязательный)
    • Gamertag
    • SignedIn
    • UserId
    • XboxUserId
    • SponsoredUser (необязательный)

Код состояния

Этот API имеет следующие предполагаемые коды состояния.

Код состояния HTTP Описание
200 Вызов GET выполнен успешно, JSON-массив пользователей возвращен в тексте ответа
204 Вызов PUT выполнен успешно, пользователи на консоли были обновлены
4XX Различные ошибки из-за недопустимых данных или формата запроса
5XX Коды ошибок для непредвиденных сбоев