既存のロールを削除する

既存のロールを削除 API を使用するには、Control Room で既存のロールを削除します。

前提条件

ロールの管理権限

ロールの管理権限を持つユーザーは、役割を削除できます。ただし、カスタム ロールのみ削除できます。システム作成のロールの場合、ID 1～16 の最初の 16 個のロールを削除できません。

JSON Web トークン (JWT)
すべての Control Room API には API にアクセスするための JSON Web トークン (JWT) が必要です。認証 API を使用して認証トークンを生成します。「認証 API」をご覧ください。
  • URL: http://<your_control_room_url>/v1/usermanagement/roles/{ID}

    角括弧内のコンテンツを Control Room の URL に置き換えます。

  • メソッド: DELETE
  • API をテストするには、Control Room にインストールされた Swagger 定義ファイルを使用します。利用可能な Swagger API は http://<your_control_room_url>/swagger/ で参照できます。
  • また、REST Client を使用してこのタスクを完了することもできます。

手順

  1. リクエスト ヘッダーに認証トークンを追加します。
    認証 API を使用して JSON Web トークンを生成します。「認証 API」をご覧ください。
  2. DELETE メソッドを選択します。
  3. リクエスト ヘッダーで、削除するロール ID を追加します。
    DELETE http://<your_control_room_url>/v1/usermanagement/roles/22
  4. リクエストを送信します。
    • Swagger で、[実行] をクリックします。
    • REST Client で SEND をクリックします。
    レスポンス本文:
    "OK"
注: また、コマンド ターミナルから REST リクエストを実行することもできます。これは、Curl リクエストの例です。この例は、読みやすいようにフォーマットされています。角括弧内のテキスト <authentication_token> を認証トークンに置き換えます。
curl -X DELETE "http://<your_control_room_url>/v1/usermanagement/roles/22" 
-H "accept: application/json" 
-H "X-Authorization: <authentication_token>" 
-H "Content-Type: application/json" -d "{22}"