セキュリティ・プロパティの非表示

管理対象の各セキュリティ・ポリシーには、セキュリティ・プロパティがあります。統合開発者は、セキュリティ・プロパティを参照し、接続の定義中にその値を指定します。ただし、値が静的であるか、アダプタのすべての接続にわたってプログラムで導出される場合、セキュリティ・プロパティを非表示にできます。

たとえば、セキュリティ・ポリシーとしてOAuth 2.0認可コードをサポートするアプリケーションを考えてみます。すべての呼出し接続で、そのセキュリティ・ポリシーを使用する必要があります。このような場合、起動接続ごとにセキュリティ・ポリシーをハード・コーディングし、セキュリティ・ポリシーを非表示にできます。これにより、統合開発者のエクスペリエンスを簡素化できます。

Visual Studio Codeの「エクスプローラ」ペインで、「定義」を展開し、アダプタ定義ドキュメントを選択します。

アダプタ定義ドキュメントには、adapter.add.jsonなどの.add.jsonの拡張子があります。

アダプタ定義ドキュメントがワークスペースに表示されます。
アダプタ定義ドキュメントのconnectionセクションを展開します。

defaultおよびhiddenプロパティを接続のnameプロパティの下に追加し、プロパティの値を指定します。

たとえば、次のコード・サンプルは、nameプロパティにデフォルト値を指定して非表示にする方法を示しています。このサンプルでは、統合開発者が接続を構成しても、パスワード・フィールドは引き続き表示されることに注意してください。

{
      "type": "managed",
      "policy": "BASIC_AUTH",
      "description": "Username and password credentials.",
      "displayName": "Username and password credentials.",
      "scope": "ACTION",
      "securityProperties": [
        {
          "name": "username",
          "default" : "FIXED_USER",
          "hidden": true,
          "required": true
        },
        {
          "name": "password",
          "displayName": "Account Password",
          "description": "<Overrides the description>",
          "shortDescription": "<Override the short description>",
          "hidden": false,
          "required": true
        }
      ]
    }

変更を保存します。