Pengguna

/v1/users/{username}

Gunakan endpoint ini untuk mengambil, menghapus, dan memperbarui akun pengguna.

Membaca

Mendapatkan informasi tentang akun pengguna tertentu.

Contoh

Untuk mengambil akun pengguna, gunakan permintaan GET pada endpoint /users/{username}:

GET /v1/users/username
Authorization: Bearer your-auth-token

Jika berhasil, tanggapan Anda akan berupa kode status HTTP 200 OK dan payload yang serupa dengan berikut:

{
   "users": [{
     "ROLES": "ROLE_ADMIN | ROLE_USER",
     "username": "username"
   }]
}

Memperbarui

Pengguna dengan peran ROLE_ADMIN dapat memperbarui kata sandi yang terkait dengan akun pengguna yang memiliki peran ROLE_ADMIN dan ROLE_USER. Pengguna individu juga dapat memperbarui kata sandi untuk akunnya sendiri. Memperbarui kata sandi akun pengguna tidak menghapus token akses yang terkait dengan pengguna tersebut. Saat ini, hanya pengguna admin yang memiliki ROLE_ADMIN; pengguna lain memiliki ROLE_USER.

Contoh

Untuk memperbarui kata sandi akun, sediakan token Bearer beserta nama pengguna dan kata sandi yang baru.

PUT /v1/users/username
Authorization: Bearer your-auth-token
   
{
  "password": "new-password"
}

Jika berhasil, kata sandi yang terkait dengan nama pengguna diperbarui. Kode status HTTP 200 OK dikembalikan, bersama dengan muatan yang serupa dengan berikut:

{
   "users": [{
      "username": "username"
   }]
}

Menghapus

Jika akun diragukan atau jika ada alasan lain untuk menghapusnya, admin harus menghapus akun. Setelah berhasil menghapus akun, semua token yang terkait dengan akun tersebut akan dihapus dari sistem.

Akun admin tidak dapat dihapus dari sistem.

Contoh

Gunakan panggilan API berikut untuk menghapus akun pengguna, dengan username adalah nama akun pengguna yang ingin Anda hapus. Token Bearer adalah token milik akun admin.

DELETE /v1/users/username
Authorization: Bearer your-auth-token

Jika berhasil, akun pengguna dihapus. Tanggapan ini mencakup kode status HTTP 200 OK dan muatan berikut:

{
   "users": [{
      "username": "username"
   }]
}

Kode Kesalahan

Kode Status HTTPAlasan

400

Nama pengguna tidak valid, admin

401

Tidak dapat memvalidasi kredensial

403

Tidak menggunakan akun admin

404

Akun tidak ada

500

Alasan tidak diketahui