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

ЗапросRequest

Вы можете получить список пользователей консоли или обновить список, например добавить, удалить пользователя, выполнить вход или выход, а также изменить существующих пользователей.You can get the list of users on the console, or update the list--adding, removing, signing in, signing out, or modifying existing users.

МетодMethod Универсальный код ресурса (URI) запросаRequest URI
GETGET /ext/user/ext/user
ОТПРАВКАPUT /ext/user/ext/user

Параметры URIURI parameters

  • НетNone

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

  • НетNone

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

Вызовы PUT должны включать массив JSON со следующей структурой:Calls to PUT should include a JSON array with the following structure:

  • ПользователиUsers
    • AutoSignIn (необязательный): логический параметр, который отключает или включает автоматический вход для учетной записи, указанной в EmailAddress или UserId.AutoSignIn (optional) : bool disabling or enabling automatic signin for the account specified by EmailAddress or UserId.
    • EmailAddress (необязательный — указывается, если UserId не предоставлен, но не для спонсированного пользователя): электронный адрес, указывающий пользователя, которого требуется изменить, добавить или удалить.EmailAddress (optional - must be provided if UserId is not provided unless signing in a sponsored user) : Email address specifying the user to modify/add/delete.
    • Password (необязательный — указывается, если пользователь в данный момент не вошел в консоль): пароль, используемый для добавления нового пользователя на консоль.Password (optional - must be provided if the user isn't currently on the console) : Password used for adding a new user to the console.
    • SignedIn (необязательный): логический параметр, указывающий, следует ли выполнить вход или выход для предоставленной учетной записи.SignedIn (optional) : bool specifying whether the provided account should be signed in or out.
    • UserId (необязательный — указывается, если EmailAddress не предоставлен, но не для спонсированного пользователя): UserId, указывающий пользователя, которого требуется изменить, добавить или удалить.UserId (optional - must be provided if EmailAddress is not provided unless signing in a sponsored user) : UserId specifying the user to modify/add/delete.
    • SponsoredUser (необязательный): логический параметр, указывающий, следует ли добавить спонсированного пользователя.SponsoredUser (optional) : bool specifying whether to add a sponsored user.
    • Delete (необязательно): логическое указание для удаления этого пользователя из консолиDelete (optional) : bool specifying to delete this user from the console

ОтветResponse

Текст ответаResponse body

Вызовы GET возвращают массив JSON со следующими свойствами.Calls to GET will return a JSON array with the following properties:

  • ПользователиUsers
    • AutoSignIn (необязательный)AutoSignIn (optional)
    • EmailAddress (необязательный)EmailAddress (optional)
    • GamertagGamertag
    • SignedInSignedIn
    • UserIdUserId
    • XboxUserIdXboxUserId
    • SponsoredUser (необязательный)SponsoredUser (optional)

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

Этот API имеет следующие предполагаемые коды состояния.This API has the following expected status codes.

Код состояния HTTPHTTP status code ОписаниеDescription
200200 Вызов GET выполнен успешно, JSON-массив пользователей возвращен в тексте ответаCall to GET was successful and JSON array of users returned in the response body
204204 Вызов PUT выполнен успешно, пользователи на консоли были обновленыCall to PUT was successful and the users on the console have been updated
4XX4XX Различные ошибки из-за недопустимых данных или формата запросаVarious errors for invalid request data or format
5XX5XX Коды ошибок для непредвиденных сбоевError codes for unexpected failures