用户

/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"
   }]
}

错误代码