ロールをリスト

Control Room のロールのリストを取得するには、List Roles API を使用します。このエンドポイントは、改ページ、ソート、およびフィルタリングをサポートしています。

リクエスト

POST http://{{ControlRoomURL}}/v1/usermanagement/roles/list

Header: X-Authorization <<authentication token>>

すべての API 呼び出しは、リクエストヘッダーに認証トークンを含める必要があります。認証 API を使用して JSON Web トークンを生成します。「認証 API」を参照してください。

フィルタなしのリクエスト本文:

{
   "sort":[
      {
         "field":"name",
         "direction":"asc"
      }
   ],
   "filter":{
      
   },
   "page":{
      "offset":0,
      "total":100,
      "totalFilter":100,
      "length":200
   }
}

フィルタ付きリクエスト本文:

{
   "sort":[
      {
         "field":"name",
         "direction":"asc"
      }
   ],
   "filter":{
      "operator":"and",
      "operands":[
         {
            "operator":"substring",
            "field":"name",
            "value":"Device"
         },
         {
            "operator":"gt",
            "field":"createdOn",
            "value":"2022-02-01T00:00:00.989Z"
         },
         {
            "operator":"lt",
            "field":"createdOn",
            "value":"2022-03-20T23:00:00.123Z"
         }
      ]
   },
   "page":{
      "offset":0,
      "total":100,
      "totalFilter":100,
      "length":200
   }
   }

リクエストパラメーター


パラメーター	タイプ	必須	説明
ソート	Array	いいえ	デフォルトでは、検索結果は ID の降順でソートされます。並べ替えはソートクエリパラメーターで指定します。並べ替えのフィールドと、その方向 `asc` (昇順) または `desc` (降順) を入力します。
filter	オブジェクト	いいえ	結果をフィルタリングします。
page	オブジェクト	いいえ	ページオブジェクトを使用すると、目的のページを取得することができます。

フィルタリング、ページネーション、およびソートの詳細については、「フィルタリング、改ページ、ソート」を参照してください。

レスポンス

{
    "page": {
        "offset": 0,
        "total": 21,
        "totalFilter": 1
    },
    "list": [
        {
            "id": 24,
            "name": "Device_admin",
            "description": "This is a device admin role",
            "countPrincipals": 1,
            "version": 1,
            "createdBy": 1,
            "createdOn": "2022-03-17T19:32:20.620Z",
            "updatedBy": 1,
            "updatedOn": "2022-03-24T02:20:13.787Z",
            "systemRole": false
        }
    ]
}

レスポンスパラメーター


パラメーター	タイプ	説明
offset	Integer	改ページに使用される、開始リストオフセット。
total	Integer	レコードの合計数。
totalFilter	Integer	フィルタ適用後のレコード数。
リスト	Array	List roles オブジェクトの配列。
List roles オブジェクト
id	Integer	特定のロールの固有の ID。
名前	文字列	ロール名。
description	文字列	ロールの説明。
countPrincipals	Integer	このロールが付与されているプリンシパル (ユーザー) の数。
バージョン	Integer	ロールインスタンスのバージョン。
createdBy	Integer	ロールを作成したユーザーの ID。
createdOn	文字列	ロールの作成タイムスタンプ。
updatedBy	Integer	ロールの最新の更新を行ったユーザーの ID。
updatedOn	文字列	ロールの最新の更新タイムスタンプ。
systemRole	Boolean	このロールがシステムロールであるかどうかを示すフラグ。

注: Community Edition で Control Room APIs を表示できますが、API 機能は制限されています。API のすべての機能にアクセスするには、Automation 360 のライセンス版が必要です。

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