特定のロール API を検索する

Automation 360

コンテンツを閉じる

コンテンツ

コンテンツを開く

PDF をダウンロード

特定のロール API を検索する

Control Room の特定のロールを取得するには、[ID 別にロールを取得] API を使用します。

前提条件

管理者ロールまたは [ロールの表示] 権限を持つカスタムロールがあることを確認します。

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

手順

リクエストヘッダーに認証トークンを追加します。
取得するロール ID を追加します。たとえば、customRole などです。
GET メソッドとエンドポイント URL: <your_control_room_url>/v1/usermanagement/roles/<role ID>

リクエストを送信します。

レスポンス本文:

{
  "id": 740,
  "createdBy": 2623,
  "createdOn": "2020-02-24T19:08:09Z",
  "updatedBy": 2623,
  "updatedOn": "2020-02-24T19:08:09Z",
  "tenantId": 1,
  "version": 0,
  "tenantUuid": "e100fbce-008c-04ec-4063-7af0af91fb2f",
  "description": "",
  "name": "customRole",
  "accessRestriction": null,
  "permissions": [
    {
      "id": 59,
      "createdBy": 0,
      "createdOn": "2019-05-21T03:09:31Z",
      "updatedBy": 0,
      "updatedOn": "2019-05-21T03:09:31Z",
      "tenantId": 1,
      "version": 0,
      "tenantUuid": "e100fbce-008c-04ec-4063-7af0af91fb2f",
      "action": "managecredentials",
      "resourceId": null,
      "resourceType": "credentials"
    },
    {
      "id": 12,
      "createdBy": 0,
      "createdOn": "2019-05-21T03:09:31Z",
      "updatedBy": 0,
      "updatedOn": "2019-05-21T03:09:31Z",
      "tenantId": 1,
      "version": 0,
      "tenantUuid": "e100fbce-008c-04ec-4063-7af0af91fb2f",
      "action": "rolesmanagement",
      "resourceId": null,
      "resourceType": "rolesmanagement"
    },
    {
      "id": 62,
      "createdBy": 0,
      "createdOn": "2019-05-21T03:09:31Z",
      "updatedBy": 0,
      "updatedOn": "2019-05-21T03:09:31Z",
      "tenantId": 1,
      "version": 0,
      "tenantUuid": "e100fbce-008c-04ec-4063-7af0af91fb2f",
      "action": "rolesview",
      "resourceId": null,
      "resourceType": "rolesmanagement"
    },
    {
      "id": 58,
      "createdBy": 0,
      "createdOn": "2019-05-21T03:09:31Z",
      "updatedBy": 0,
      "updatedOn": "2019-05-21T03:09:31Z",
      "tenantId": 1,
      "version": 0,
      "tenantUuid": "e100fbce-008c-04ec-4063-7af0af91fb2f",
      "action": "myschedule",
      "resourceId": null,
      "resourceType": "taskscheduling"
    },
    {
      "id": 97,
      "createdBy": 0,
      "createdOn": "2019-05-21T03:09:39Z",
      "updatedBy": 0,
      "updatedOn": "2019-05-21T03:09:39Z",
      "tenantId": 1,
      "version": 0,
      "tenantUuid": "e100fbce-008c-04ec-4063-7af0af91fb2f",
      "action": "view",
      "resourceId": null,
      "resourceType": "dashboard"
    },
    {
      "id": 30,
      "createdBy": 0,
      "createdOn": "2019-05-21T03:09:31Z",
      "updatedBy": 0,
      "updatedOn": "2019-05-21T03:09:31Z",
      "tenantId": 1,
      "version": 0,
      "tenantUuid": "e100fbce-008c-04ec-4063-7af0af91fb2f",
      "action": "view",
      "resourceId": null,
      "resourceType": "devices"
    }
  ],
  "countPrincipals": 0,
  "principals": []
}

REST API は、HTTP レスポンスコードで各リクエストに応答します。レスポンスコードの詳細は、API レスポンスコードを参照してください。

フィードバックを送る