次の方法で共有

MinimalPermissionsPlugin

  • [アーティクル]

アプリが最小限のアクセス許可を使用して API を呼び出すかどうかを確認します。 指定したローカル フォルダーの API 情報を使用します。

記録された API 要求でトークンが最小限の API アクセス許可を使用しているかどうかを確認する開発プロキシを示すコマンド ラインのスクリーンショット。

プラグイン インスタンスの定義

{
  "name": "MinimalPermissionsPlugin",
  "enabled": true,
  "pluginPath": "~appFolder/plugins/dev-proxy-plugins.dll",
  "configSection": "minimalPermissionsPlugin"
}

構成の例

{
  "minimalPermissionsPlugin": {
    "apiSpecsFolderPath": "./api-specs"
  }
}

構成プロパティ

プロパティ 説明 Default
apiSpecsFolderPath API 仕様を使用したフォルダーへの相対パスまたは絶対パス なし

コマンドライン オプション

なし

解説

このプラグインは MinimalPermissionsPlugin 、アプリが最小限のアクセス許可を使用して API を呼び出しているかどうかを確認します。 アクセス許可を確認するために、プラグインは、指定されたローカル フォルダーにある API に関する情報を使用します。

API のアクセス許可を定義する

このプラグインでは MinimalPermissionsPlugin 、OAuth で保護された API の OAuth アクセス許可の確認がサポートされています。 プラグインは、指定された API 仕様の情報を使用して、アプリで使用される API を呼び出すために必要な最小限のアクセス許可を計算します。 次に、プラグインは、JSON Web トークン (JWT) トークンで使用されるアクセス許可を、Dev Proxy が記録した要求に必要な最小限のスコープと比較します。

API のアクセス許可を定義するには、API の OpenAPI 定義に含めます。 次の例は、OpenAPI 定義で API のアクセス許可を定義する方法を示しています。

{
  "openapi": "3.0.1",
  "info": {
    "title": "Northwind API",
    "description": "Northwind API",
    "version": "v1.0"
  },
  "servers": [
    {
      "url": "https://api.northwind.com"
    }
  ],
  "components": {
    "securitySchemes": {
      "OAuth2": {
        "type": "oauth2",
        "flows": {
          "authorizationCode": {
            "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize",
            "tokenUrl": "https://login.microsoftonline.com/common/oauth2/token",
            "scopes": {
              "customer.read": "Grants access to ready customer info",
              "customer.readwrite": "Grants access to read and write customer info"
            }
          }
        }
      }
    },
    "schemas": {
      "Customer": {
        "type": "object",
        // [...] trimmed for brevity
      }
    }
  },
  "paths": {
    "/customers/{customers-id}": {
      "description": "Provides operations to manage a customer",
      "get": {
        "summary": "Get customer by ID",
        "operationId": "getCustomerById",
        "security": [
          {
            "OAuth2": [
              "customer.read"
            ]
          },
          {
            "OAuth2": [
              "customer.readwrite"
            ]
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json; charset=utf-8": {
                "schema": {
                  "$ref": "#/components/schemas/Customer"
                }
              }
            }
          }
        }
      },
      "patch": {
        "summary": "Update customer by ID",
        "operationId": "updateCustomerById",
        "security": [
          {
            "OAuth2": [
              "customer.readwrite"
            ]
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/Customer"
              }
            }
          }
        },
        "responses": {
          "204": {
            "description": "No Content"
          }
        }
      },
      "parameters": [
        {
          "name": "customers-id",
          "in": "path",
          "required": true,
          "schema": {
            "type": "string"
          }
        }
      ]
    }
  },
  "x-ms-generated-by": {
    "toolName": "Dev Proxy",
    "toolVersion": "0.22.0"
  }
}

関連する部分は securitySchemes 、API で使用する OAuth スコープを定義するセクションです。 次に、操作ごとに、セクションに必要なスコープを security 含めます。

詳細