Người dùng

/v1/users/{username}

Dùng điểm cuối này để truy xuất, xóa hoặc cập nhật tài khoản người dùng.

Đọc

Lấy thông tin về một tài khoản người dùng cụ thể.

Ví dụ

Để truy xuất tài khoản người dùng, hãy sử dụng yêu cầu GET trên điểm cuối /users/{username}:

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

Khi thành công, phản hồi của bạn sẽ có mã trạng thái HTTP là 200 OK cùng với phần tải dữ liệu tương tự như sau:

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

Cập nhật

Người dùng có vai trò ROLE_ADMIN có thể cập nhật mật khẩu liên kết với tài khoản người dùng có vai trò ROLE_ADMINROLE_USER. Người dùng cá nhân cũng có thể cập nhật mật khẩu tài khoản của riêng họ. Việc cập nhật mật khẩu tài khoản người dùng không làm mất hiệu lực bất kỳ mã truy cập nào liên kết với người dùng đó. Hiện tại, chỉ người dùng admin mới có ROLE_ADMIN; những người dùng khác có ROLE_USER.

Ví dụ

Để cập nhật mật khẩu cho một tài khoản, hãy cung cấp mã Bearer cùng với tên người dùng và mật khẩu mới.

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

Nếu thành công, mật khẩu liên kết với tên người dùng sẽ được cập nhật. Hệ thống sẽ trả về mã trạng thái HTTP 200 OK cùng với phần tải dữ liệu tương tự như sau:

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

Xóa

Nếu một tài khoản bị xâm phạm hoặc có bất kỳ lý do nào khác để xóa tài khoản, admin phải xóa tài khoản đó. Sau khi bạn xóa tài khoản thành công, tất cả mã liên kết với tài khoản này đều bị gỡ khỏi hệ thống.

Không thể gỡ tài khoản admin khỏi hệ thống.

Ví dụ

Sử dụng lệnh gọi API sau để xóa tài khoản người dùng, trong đó username là tên của tài khoản người dùng mà bạn muốn xóa. Mã Bearer là mã thuộc về tài khoản admin.

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

Nếu thành công, tài khoản người dùng sẽ bị xóa. Phản hồi bao gồm mã trạng thái HTTP là 200 OK và phần tải dữ liệu sau:

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

Mã lỗi

Mã trạng thái HTTPLý do

400

Tên người dùng không hợp lệ, admin

401

Không thể xác thực thông tin đăng nhập

403

Hiện không sử dụng tài khoản admin

404

Tài khoản không tồn tại

500

Lý do không xác định