フィルターを使用した資格情報の検索

フィルターで POST リクエストを送信して、特定の ロッカー に属する資格情報のリストを返します。

前提条件

JSON Web トークン (JWT)
すべての Control Room API には API にアクセスするための JSON Web トークン (JWT) が必要です。認証 API を使用して認証トークンを生成します。
注:
  • API をテストするには、Control Room にインストールされた Swagger 定義ファイルを使用します。利用可能な Swagger API は http://<your_control_room_url>/swagger/ で参照できます。
  • また、REST Client を使用してこのタスクを完了することもできます。

手順

  1. リクエスト ヘッダーに認証トークンを追加します。
    注: 認証 API を使用して JSON Web トークンを生成します。
  2. メソッドと URL を指定します。
    • メソッド: POST
    • URL: http://<your_control_room_url>/v2/credentialvault/credentials/list
  3. オプション: クエリ パラメーターを追加して、userProvided が設定した資格情報のみを返し、使用したことを確認します。
    http://<your_control_room_url>/v2/credentialvault/credentials/list?consumed=true
  4. 利用できるすべての資格情報をリクエストするには、リクエスト本文を空白にします。リクエスト本文にフィルター パラメーターを追加して、利用可能なすべての資格情報から返される情報を制限することができます。
    注: 資格情報名を使用してのみ結果をフィルターできます。
    リクエスト本文の例には、次のパラメーターが含まれます。
    • 名前が以下の ロッカー を検索します。E メール接続の資格情報。
    • 資格情報名で結果を並べ替えます。
    リクエスト本文:
    {
      "sort": [
        {
          "field": "name",
          "direction": "asc"
        }
      ],
      "filter": {
        "operator": "substring",
        "value": "Email connection credentials",
        "field": "name"
      },
      "fields": [
        
      ],
      "page": {
        "offset": 0,
        "total": 3,
        "totalFilter": 3,
        "length": 200
      }
    }
  5. リクエストを送信します。
    • REST Client で [SEND] をクリックします。
    • Swagger インターフェースで [実行] をクリックします。

    レスポンス本文: この例のレスポンスは、以下の資格情報名情報を返します。E メール接続の資格情報。

    {
      "page": {
        "offset": 0,
        "total": 3,
        "totalFilter": 1
      },
      "list": [
        {
          "id": "21",
          "name": "Email connection credentials",
          "description": "",
          "lockerId": "2",
          "ownerId": "14",
          "attributes": [
            {
              "id": "71",
              "name": "gmail password",
              "description": "",
              "userProvided": true,
              "masked": false,
              "createdBy": "14",
              "createdOn": "2020-01-24T18:18:44.132Z",
              "updatedBy": "14",
              "updatedOn": "2020-01-24T20:01:34.465Z",
              "version": "2",
              "passwordFlag": true
            }
          ],
          "createdBy": "14",
          "createdOn": "2020-01-24T18:18:44.132Z",
          "updatedBy": "14",
          "updatedOn": "2020-01-27T18:08:39.418Z",
          "version": "3",
          "completed": false
        }
      ]
    }
注: また、コマンド ターミナルから REST リクエストを実行することもできます。これは、Curl リクエストの例です。この例は、読みやすいようにフォーマットされています。角括弧内のテキスト <authentication_token> を認証トークンに置き換えます。
curl -X POST "<your_control_room_url>/v1/repository/filefolder/list" -H "accept: application/json"
        -H "X-Authorization: <authentication_token>" -H "Content-Type: application/json"
        -d "{   
            \"fields\": [],
            \"filter\": {
                 \"field\": \"lockerId\", 
                 \"value\": \"2\"
                 },
            \"sort\": [ {
                \"field\": \"id\",
                \"direction\": \"asc\"
                } ],
            \"page\": { 
                \"offset\": 0,
                \"length\": 0 
            }}"