第8章 ユーザーロール API

8.1. ユーザーのロールの一覧表示

8.1.1. 説明

現在ログインされているユーザーのロールを一覧表示します。

8.1.2. エンドポイント

  • URI: /box/srv/1.1/admin/role/list
  • メソッド: POST

8.1.3. リクエストボディー

{}

8.1.4. レスポンスボディー

8.1.4.1. 成功

{
  "status": "ok",
  "list": ["sub", "dev"]
}

8.1.4.2. エラー

{
  "status": "error",
  "message": "<error_message>"
}

8.2. ユーザーの割り当て可能ロールの一覧表示

8.2.1. 説明

現在ログインされているユーザーの割り当て可能なロールを一覧表示します (例: このユーザーが他のユーザーに割り当てることのできるロール)。

8.2.2. エンドポイント

  • URI: /box/srv/1.1/admin/role/listAssignable
  • メソッド: POST

8.2.3. リクエストボディー

{}

8.2.4. レスポンスボディー

8.2.4.1. 成功

{
  "status": "ok",
  "list": ["sub", "dev", "devadmin", "analytics", "portaladmin"]
}

8.2.4.2. エラー

{
  "status": "error",
  "message": "<error_message>"
}