ユーザー

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

エラーコード