Gerenciamento do usuário do Xbox LiveXbox Live User Management

SolicitaçãoRequest

Você pode obter a lista de usuários no console ou atualizar a lista adicionando, removendo, entrando, saindo ou modificando usuários existentes.You can get the list of users on the console, or update the list--adding, removing, signing in, signing out, or modifying existing users.

MétodoMethod URI da solicitaçãoRequest URI
GETGET /ext/user/ext/user
PUTPUT /ext/user/ext/user

Parâmetros de URIURI parameters

  • NãoNone

Cabeçalhos de solicitaçãoRequest headers

  • NãoNone

Corpo da solicitaçãoRequest body

As chamadas para PUT devem incluir uma matriz JSON com a seguinte estrutura:Calls to PUT should include a JSON array with the following structure:

  • UsuáriosUsers
    • AutoSignIn (opcional): bool desabilitando ou habilitando a entrada automática da conta especificada por EmailAddress ou UserId.AutoSignIn (optional) : bool disabling or enabling automatic signin for the account specified by EmailAddress or UserId.
    • EmailAddress (opcional – deverá ser fornecido se UserId não for fornecido, a menos que haja a entrada de um usuário patrocinado): endereço de e-mail especificando o usuário a ser modificado/adicionado/excluído.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 (opcional – deverá ser fornecido se o usuário não estiver no console no momento): senha usada para adicionar um novo usuário ao console.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 (opcional): bool especificando se deve haver entra ou saída da conta fornecida.SignedIn (optional) : bool specifying whether the provided account should be signed in or out.
    • UserId (opcional – deverá ser fornecido se EmailAddress não for fornecido, a menos que haja a entrada de um usuário patrocinado): UserId especificando o usuário a ser modificado/adicionado/excluído.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 (opcional): bool especificando se é necessário adicionar um usuário patrocinado ou não.SponsoredUser (optional) : bool specifying whether to add a sponsored user.
    • Delete (opcional): BOOL especificando para excluir este usuário do consoleDelete (optional) : bool specifying to delete this user from the console

RespostaResponse

Corpo da respostaResponse body

Chamadas para GET retornará uma matriz JSON com as seguintes propriedades:Calls to GET will return a JSON array with the following properties:

  • UsuáriosUsers
    • AutoSignIn (opcional)AutoSignIn (optional)
    • EmailAddress (opcional)EmailAddress (optional)
    • GamertagGamertag
    • SignedInSignedIn
    • UserIdUserId
    • XboxUserIdXboxUserId
    • SponsoredUser (opcional)SponsoredUser (optional)

Código de statusStatus code

Esta API tem os códigos de status esperados a seguir.This API has the following expected status codes.

Código de status HTTPHTTP status code DescriçãoDescription
200200 A chamada para GET foi bem-sucedida e a matriz JSON de usuários retornou no corpo da respostaCall to GET was successful and JSON array of users returned in the response body
204204 A chamada para PUT foi bem-sucedida e os usuários no console foram atualizadosCall to PUT was successful and the users on the console have been updated
4XX4XX Diversos erros de dados ou formato de solicitação inválidosVarious errors for invalid request data or format
5XX5XX Códigos de erro de falhas inesperadasError codes for unexpected failures