Manajemen Pengguna Xbox Live

Minta

Anda bisa mendapatkan daftar pengguna di konsol, atau memperbarui daftar - menambahkan, menghapus, masuk, keluar, atau memodifikasi pengguna yang sudah ada.

Metode URI Permintaan
GET /ext/user
PUT /ext/user

Parameter URI

  • Tidak ada

Header permintaan

  • Tidak ada

Isi permintaan

Panggilan ke PUT harus menyertakan array JSON dengan struktur berikut:

  • Pengguna
    • AutoSignIn (opsional): bool menonaktifkan atau mengaktifkan masuk otomatis untuk akun yang ditentukan oleh EmailAddress atau UserId.
    • EmailAddress (opsional - harus disediakan jika UserId tidak disediakan kecuali masuk ke pengguna yang disponsori) : Alamat email yang menentukan pengguna untuk memodifikasi/menambah/menghapus.
    • Kata sandi (opsional - harus disediakan jika pengguna saat ini tidak ada di konsol) : Kata sandi yang digunakan untuk menambahkan pengguna baru ke konsol.
    • SignedIn (opsional) : bool menentukan apakah akun yang disediakan harus masuk atau keluar.
    • UserId (opsional - harus disediakan jika EmailAddress tidak disediakan kecuali masuk ke pengguna yang disponsori): UserId menentukan pengguna untuk memodifikasi / menambah / menghapus.
    • SponsoredUser (opsional) : bool menentukan apakah akan menambahkan pengguna yang disponsori.
    • Hapus (opsional) : bool menentukan untuk menghapus pengguna ini dari konsol

Respons

Isi respons

Panggilan ke GET akan mengembalikan array JSON dengan properti berikut:

  • Pengguna
    • Tanda Tangan Otomatis (opsional)
    • EmailAddress (opsional)
    • Gamertag
    • SignedIn
    • UserId
    • XboxUserId
    • SponsoredUser (opsional)

Kode status

API ini memiliki kode status yang diharapkan berikut.

Kode status HTTP Deskripsi
200 Panggilan ke GET berhasil dan array JSON pengguna kembali di badan respons
204 Panggilan ke PUT berhasil dan pengguna di konsol telah diperbarui
4XX Berbagai kesalahan untuk data atau format permintaan yang tidak valid
5XX Kode kesalahan untuk kegagalan tak terduga