Gestione degli utenti di Xbox LiveXbox Live User Management

RichiestaRequest

Puoi ottenere l'elenco degli utenti nella console o aggiornare l'elenco, aggiungendo, rimuovendo, connettendo, sconnettendo o modificando utenti esistenti.You can get the list of users on the console, or update the list--adding, removing, signing in, signing out, or modifying existing users.

MetodoMethod URI richiestaRequest URI
GETGET /ext/user/ext/user
PUTPUT /ext/user/ext/user

Parametri URIURI parameters

  • NessunoNone

Intestazioni della richiestaRequest headers

  • NessunoNone

Corpo della richiestaRequest body

Le chiamate a PUT devono includere una matrice JSON con la struttura seguente:Calls to PUT should include a JSON array with the following structure:

  • UtentiUsers
    • AutoSignIn (facoltativa): valore booleano che abilita o disabilita l'accesso automatico per l'account specificato da EmailAddress o UserId.AutoSignIn (optional) : bool disabling or enabling automatic signin for the account specified by EmailAddress or UserId.
    • EmailAddress (facoltativa, deve essere specificata se non si specifica UserId, a meno che non venga connesso un utente sponsorizzato): indirizzo di posta elettronica che specifica l'utente da modificare/aggiungere/eliminare.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 (facoltativa, deve essere specificata se l'utente non è attualmente nella console): password usata per aggiungere un nuovo utente alla 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 (facoltativa): valore booleano che indica se l'account specificato deve essere connesso o disconnesso.SignedIn (optional) : bool specifying whether the provided account should be signed in or out.
    • UserId (facoltativa, deve essere specificata se non si specifica EmailAddress, a meno che non venga connesso un utente sponsorizzato): ID utente che specifica l'utente da modificare/aggiungere/eliminare.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 (facoltativa): valore booleano che specifica se aggiungere un utente sponsorizzato.SponsoredUser (optional) : bool specifying whether to add a sponsored user.
    • Delete (facoltativo): bool che specifica di eliminare l'utente dalla consoleDelete (optional) : bool specifying to delete this user from the console

RispostaResponse

Corpo della rispostaResponse body

Le chiamate a GET restituiscono una matrice JSON con le proprietà seguenti:Calls to GET will return a JSON array with the following properties:

  • UtentiUsers
    • AutoSignIn (facoltativa)AutoSignIn (optional)
    • EmailAddress (facoltativa)EmailAddress (optional)
    • GamertagGamertag
    • SignedInSignedIn
    • UserIdUserId
    • XboxUserIdXboxUserId
    • SponsoredUser (facoltativa)SponsoredUser (optional)

Codice di statoStatus code

Questa API ha i codici di stato previsto seguenti.This API has the following expected status codes.

Codice di stato HTTPHTTP status code DescrizioneDescription
200200 La chiamata a GET è riuscita ed è stata restituita una matrice JSON di utenti nel contenuto della rispostaCall to GET was successful and JSON array of users returned in the response body
204204 La chiamata a PUT è riuscita e sono stati aggiornati gli utenti nella consoleCall to PUT was successful and the users on the console have been updated
4XX4XX Errori vari per dati o formato della richiesta non validiVarious errors for invalid request data or format
5XX5XX Codici di errore per errori imprevistiError codes for unexpected failures