新しいロールを作成

新規ロールの作成 API を使用して、Control Room の権限を持つ新しいロールを作成します。

前提条件

ロールの表示と管理
ロールの表示と管理権限のあるユーザーは、役割を表示、作成、管理できます。
JSON Web トークン (JWT)
すべての Control Room API には API にアクセスするための JSON Web トークン (JWT) が必要です。認証 API を使用して認証トークンを生成します。「認証 API」をご覧ください。
  • URL: http://<your_control_room_url>/v1/usermanagement/roles

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

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

手順

  1. リクエスト ヘッダーに認証トークンを追加します。
    認証 API を使用して JSON Web トークンを生成します。「認証 API」をご覧ください。
  2. [POST] メソッドを選択します。
    POST http://<your_control_room_url>/v1/usermanagement/roles
  3. リクエスト本文で、ロールの新しい名前を入力します。
  4. リクエストを送信します。
    パラメーター名 必須 タイプ 説明:
    名前: はい 文字列 (最大 255 文字) 役割名
    説明: いいえ。 文字列 (最大 255 文字) ロールの内容

    次のリクエストは、次の権限を持つ新しいロールを作成します。IDアクション、およびリソースタイプ

    リクエスト本文:
    {
      "name": "User-Role-Management",
      "description": "",
      "permissions": [
        {
          "id": 58,
          "action": "myschedule",
          "resourceType": "taskscheduling",
          "resourceId": null
        },
        {
          "id": 59,
          "action": "managecredentials",
          "resourceType": "credentials",
          "resourceId": null
        },
        {
          "id": 30,
          "action": "view",
          "resourceType": "devices",
          "resourceId": null
        },
        {
          "id": 97,
          "action": "viewbotstore",
          "resourceType": "botstore",
          "resourceId": null
        },
        {
          "id": 102,
          "action": "viewuserbasic",
          "resourceType": "usermanagement",
          "resourceId": null
        },
        {
          "id": 3,
          "action": "createuser",
          "resourceType": "usermanagement",
          "resourceId": null
        },
        {
          "id": 4,
          "action": "updateuser",
          "resourceType": "usermanagement",
          "resourceId": null
        },
        {
          "id": 2,
          "action": "deleteuser",
          "resourceType": "usermanagement",
          "resourceId": null
        },
        {
          "id": 1,
          "action": "usermanagement",
          "resourceType": "usermanagement",
          "resourceId": null
        },
        {
          "id": 12,
          "action": "rolesmanagement",
          "resourceType": "rolesmanagement",
          "resourceId": null
        },
        {
          "id": 90,
          "action": "rolesview",
          "resourceType": "rolesmanagement",
          "resourceId": null
        }
      ],
      "principals": []
    }
  5. リクエストを送信します。
    • Swagger で、[実行] をクリックします。
    • REST Client で SEND をクリックします。
    レスポンス本文:
    {
      "id": 42,
      "createdBy": 36,
      "createdOn": "2019-12-26T19:51:24Z",
      "updatedBy": 36,
      "updatedOn": "2019-12-26T19:51:24Z",
      "tenantId": 1,
      "version": 0,
      "status": "Active",
      "description": "",
      "name": "User-Role-Management",
      "accessRestriction": null,
      "permissions": [{
        "id": 1,
        "createdBy": 0,
        "createdOn": "2019-10-03T23:53:35Z",
        "updatedBy": 0,
        "updatedOn": "2019-10-03T23:53:35Z",
        "tenantId": 1,
        "version": 0,
        "status": null,
        "action": "usermanagement",
        "resourceId": null,
        "resourceType": "usermanagement"
      }, {
        "id": 59,
        "createdBy": 0,
        "createdOn": "2019-10-03T23:53:47Z",
        "updatedBy": 0,
        "updatedOn": "2019-10-03T23:53:47Z",
        "tenantId": 1,
        "version": 0,
        "status": null,
        "action": "managecredentials",
        "resourceId": null,
        "resourceType": "credentials"
      }, {
        "id": 2,
        "createdBy": 0,
        "createdOn": "2019-10-03T23:53:35Z",
        "updatedBy": 0,
        "updatedOn": "2019-10-03T23:53:35Z",
        "tenantId": 1,
        "version": 0,
        "status": null,
        "action": "deleteuser",
        "resourceId": null,
        "resourceType": "usermanagement"
      }, {
        "id": 4,
        "createdBy": 0,
        "createdOn": "2019-10-03T23:53:35Z",
        "updatedBy": 0,
        "updatedOn": "2019-10-03T23:53:35Z",
        "tenantId": 1,
        "version": 0,
        "status": null,
        "action": "updateuser",
        "resourceId": null,
        "resourceType": "usermanagement"
      }, {
        "id": 12,
        "createdBy": 0,
        "createdOn": "2019-10-03T23:53:35Z",
        "updatedBy": 0,
        "updatedOn": "2019-10-03T23:53:35Z",
        "tenantId": 1,
        "version": 0,
        "status": null,
        "action": "rolesmanagement",
        "resourceId": null,
        "resourceType": "rolesmanagement"
      }, {
        "id": 90,
        "createdBy": 0,
        "createdOn": "2019-10-03T23:54:11Z",
        "updatedBy": 0,
        "updatedOn": "2019-10-03T23:54:11Z",
        "tenantId": 1,
        "version": 0,
        "status": null,
        "action": "rolesview",
        "resourceId": null,
        "resourceType": "rolesmanagement"
      }, {
        "id": 58,
        "createdBy": 0,
        "createdOn": "2019-10-03T23:53:47Z",
        "updatedBy": 0,
        "updatedOn": "2019-10-03T23:53:47Z",
        "tenantId": 1,
        "version": 0,
        "status": null,
        "action": "myschedule",
        "resourceId": null,
        "resourceType": "taskscheduling"
      }, {
        "id": 3,
        "createdBy": 0,
        "createdOn": "2019-10-03T23:53:35Z",
        "updatedBy": 0,
        "updatedOn": "2019-10-03T23:53:35Z",
        "tenantId": 1,
        "version": 0,
        "status": null,
        "action": "createuser",
        "resourceId": null,
        "resourceType": "usermanagement"
      }, {
        "id": 97,
        "createdBy": 0,
        "createdOn": "2019-10-03T23:54:12Z",
        "updatedBy": 0,
        "updatedOn": "2019-10-03T23:54:12Z",
        "tenantId": 1,
        "version": 0,
        "status": null,
        "action": "viewbotstore",
        "resourceId": null,
        "resourceType": "botstore"
      }, {
        "id": 30,
        "createdBy": 0,
        "createdOn": "2019-10-03T23:53:37Z",
        "updatedBy": 0,
        "updatedOn": "2019-10-03T23:53:37Z",
        "tenantId": 1,
        "version": 0,
        "status": null,
        "action": "view",
        "resourceId": null,
        "resourceType": "devices"
      }, {
        "id": 102,
        "createdBy": 0,
        "createdOn": "2019-11-21T19:08:20Z",
        "updatedBy": 0,
        "updatedOn": "2019-11-21T19:08:20Z",
        "tenantId": 1,
        "version": 0,
        "status": "Active",
        "action": "runtimeclientsmanagement",
        "resourceId": "2",
        "resourceType": "runtimeclientsmanagement"
      }],
      "countPrincipals": 0,
      "principals": []
    }
注: また、コマンド ターミナルから REST リクエストを実行することもできます。これは、Curl リクエストの例です。この例は、読みやすいようにフォーマットされています。角括弧内のテキスト <authentication_token> を認証トークンに置き換えます。
curl -X POST "http://<your_control_room_url>/v1/usermanagement/roles" 
-H "accept: application/json" 
-H "X-Authorization: <authentication_token>" 
-H "Content-Type: application/json" -d '{
  "name": "User-Role-Management",
  "description": "",
  "permissions": [
    {
      "id": 58,
      "action": "myschedule",
      "resourceType": "taskscheduling",
      "resourceId": null
    },
    {
      "id": 59,
      "action": "managecredentials",
      "resourceType": "credentials",
      "resourceId": null
    },
    {
      "id": 30,
      "action": "view",
      "resourceType": "devices",
      "resourceId": null
    },
    {
      "id": 97,
      "action": "viewbotstore",
      "resourceType": "botstore",
      "resourceId": null
    },
    {
      "id": 102,
      "action": "viewuserbasic",
      "resourceType": "usermanagement",
      "resourceId": null
    },
    {
      "id": 3,
      "action": "createuser",
      "resourceType": "usermanagement",
      "resourceId": null
    },
    {
      "id": 4,
      "action": "updateuser",
      "resourceType": "usermanagement",
      "resourceId": null
    },
    {
      "id": 2,
      "action": "deleteuser",
      "resourceType": "usermanagement",
      "resourceId": null
    },
    {
      "id": 1,
      "action": "usermanagement",
      "resourceType": "usermanagement",
      "resourceId": null
    },
    {
      "id": 12,
      "action": "rolesmanagement",
      "resourceType": "rolesmanagement",
      "resourceId": null
    },
    {
      "id": 90,
      "action": "rolesview",
      "resourceType": "rolesmanagement",
      "resourceId": null
    }
  ],
  "principals": []
}'