用戶

/v1/users/{username}

此端點可用來擷取、刪除或更新用戶帳號。

讀取

取得特定用戶帳號的相關資訊。

範例

若要擷取用戶帳號，請在 /users/{username} 端點上使用 GET 要求：

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

成功時，回應為 HTTP 狀態代碼 200 OK，以及如下承載：

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

更新

具有 ROLE_ADMIN 角色的用戶可更新具有 ROLE_ADMIN 和 ROLE_USER 角色之用戶帳號的關聯密碼。個別用戶也可更新自己帳號的密碼。更新用戶帳號密碼不會使與該用戶關聯的任何存取權杖失效。目前只有 admin 用戶具有 ROLE_ADMIN；其他用戶皆具有 ROLE_USER。

範例

若要更新帳號的密碼，請提供 Bearer 權杖，以及用戶名稱和新密碼。

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

如果成功，就會更新與該用戶名稱關聯的密碼。系統會傳回 HTTP 狀態代碼 200 OK，以及如下承載：

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

刪除

如果帳號遭盜用或有任何其他原因需要刪除帳號，admin 必須刪除該帳號。成功刪除帳號後，系統將移除所有與該帳號關聯的權杖。

範例

使用下列 API 呼叫刪除用戶帳號，其中 username 為想要刪除的用戶帳號名稱。Bearer 權杖屬於 admin 帳號。

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

如果成功，便會刪除該用戶帳號。回應包含 HTTP 狀態代碼 200 OK 和下列承載：

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

錯誤代碼