ロールの検索

ロールの検索 API を使用して、日付フィルター、ソート、および改ページに基づいてロールを検索します。

前提条件

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

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

  • メソッド: POST

手順

  1. リクエスト ヘッダーに認証トークンを追加します。
    認証 API を使用して JSON Web トークンを生成します。「認証 API」をご覧ください。
  2. [POST] メソッドを選択します。
    POST http://<your_control_room_url>/v1/usermanagement/roles/list
    フィルターを適用して、Web ページの基本的な条件付きクエリおよび改ページの制御を実行します。フィルタリングには、フィルタリングの条件、列の並び替え、改ページ パラメーターという 3 つの基本的な機能があります。「API リクエスト本文でフィルタリング」をご覧ください。

    次のリクエストは、page: offset や length などの改ページ フィルターを設定します。

  3. リクエストを送信します。
    • REST Client で SEND をクリックします。
    • Swagger インターフェースで [実行] をクリックします。

    リクエスト本文:

    {
"sort": [
  {
   "field": "name",
   "direction": "asc"
  }
],
"filter": {
  "operator": "substring",
  "value": "sample",
  "field": "name"
},
"fields": [],
"page": {
  "offset": 0,
  "total": 23,
  "totalFilter": 23,
  "length": 200
}
}

    レスポンス本文:

    この例のレスポンスでは、名前フィールドに sample を含むすべてのロールが取得されます。

    {
"page": {
  "offset": 0,
  "total": 37,
  "totalFilter": 3
},
"list": [
  {
   "id": 40,
   "name": "API_Roles_sample",
   "description": "",
   "countPrincipals": 0,
   "version": 0,
   "createdBy": 36,
   "createdOn": "2019-12-18T21:02:49.087Z",
   "updatedBy": 36,
   "updatedOn": "2019-12-18T21:02:49.087Z"
  },
  {
   "id": 39,
   "name": "API_sample",
   "description": "",
   "countPrincipals": 0,
   "version": 0,
   "createdBy": 36,
   "createdOn": "2019-12-18T21:01:58.383Z",
   "updatedBy": 36,
   "updatedOn": "2019-12-18T21:01:58.383Z"
  },
  {
   "id": 38,
   "name": "sample_1",
   "description": "",
   "countPrincipals": 0,
   "version": 0,
   "createdBy": 36,
   "createdOn": "2019-12-18T21:01:12.623Z",
   "updatedBy": 36,
   "updatedOn": "2019-12-18T21:01:12.623Z"
  }
]
}
注: また、コマンド ターミナルから REST リクエストを実行することもできます。これは、Curl リクエストの例です。この例は、読みやすいようにフォーマットされています。角括弧内のテキスト <authentication_token> を認証トークンに置き換えます。
curl -X POST "http://<your_control_room_url>/v1/usermanagment/roles/list" 
-H "accept: application/json" 
-H "X-Authorization: <authentication_token>" 
-H "Content-Type: application/json" -d "{
  {
"sort": [
  {
   "field": "name",
   "direction": "asc"
  }
],
"filter": {
  "operator": "substring",
  "value": "sample",
  "field": "name"
},
"fields": [],
"page": {
  "offset": 0,
  "total": 23,
  "totalFilter": 23,
  "length": 200
}
}'