AuthPlugin

API キーまたは OAuth2 を使用して認証と承認をシミュレートします。

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

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

構成例: API キー

{
  "auth": {
    "type": "apiKey",
    "apiKey": {
      "parameters": [
        {
          "in": "header",
          "name": "x-api-key"
        },
        {
          "in": "query",
          "name": "code"
        }
      ],
      "allowedKeys": [
        "1234"
      ]
    }
  }
}

構成例: OAuth2

{
  "auth": {
    "type": "oauth2",
    "oauth2": {
      "metadataUrl": "https://login.microsoftonline.com/organizations/v2.0/.well-known/openid-configuration",
      "allowedApplications": [
        "00000000-0000-0000-0000-000000000000"
      ],
      "allowedAudiences": [
        "00000000-0000-0000-0000-000000000000"
      ],
      "allowedPrincipals": [
        "00000000-0000-0000-0000-000000000000"
      ],
      "allowedTenants":[
        "00000000-0000-0000-0000-000000000000"
      ],
      "issuer": "https://login.microsoftonline.com/ffffffff-eeee-dddd-cccc-bbbbbbbbbbb0/v2.0",
      "scopes": [
        "Posts.Read"
      ],
      "validateLifetime": true,
      "validateSigningKey": true
    }
  }
}

構成プロパティ

プロパティ	内容	必須
type	開発プロキシで使用する必要がある認証と承認の種類。 使用できる値: apiKey、 oauth2	はい
apiKey	API キーの認証と承認の構成。	はい( type の場合) apiKey
oauth2	OAuth2 認証と承認の構成。	はい( type の場合) oauth2

API キーの構成プロパティ

プロパティ	内容	必須
allowedKeys	許可されている API キーの一覧。	はい
parameters	API キーを含むパラメーターの一覧。	はい

パラメーター構成プロパティ

プロパティ	内容	必須
in	パラメーターが見つかると予想される場所。 使用できる値: header、query、cookie	はい
name	パラメーターの名前。	はい

OAuth2 構成プロパティ

プロパティ	内容	必須
metadataUrl	OpenID Connect メタデータ ドキュメントの URL。	はい
allowedApplications	許可されているアプリケーション ID の一覧。 トークンが発行されるアプリケーション (appid または azp 要求) を検証しないようにするには、空のままにします。	いいえ
allowedAudiences	許可されている対象ユーザーの一覧。 トークンが発行された対象ユーザー (aud 要求) を検証しない場合は、空のままにします。	いいえ
allowedPrincipals	許可されるプリンシパルの一覧。 トークンが発行されるプリンシパル (oid 要求) を検証しない場合は、空のままにします。	いいえ
allowedTenants	許可されているテナントの一覧。 トークンが発行されるテナント (tid 要求) を検証しない場合は、空のままにします。	いいえ
issuer	許可されたトークン発行者。 トークン発行者を検証しない場合は、空のままにします。	いいえ
roles	許可されているロールの一覧。 トークンのロール (roles 要求) を検証しない場合は、空のままにします。	いいえ
scopes	許可されるスコープの一覧。 トークンのスコープ (scp 要求) を検証しない場合は、空のままにします。	いいえ
validateLifetime	トークンの有効期間の検証を無効にするには、 false に設定します。 既定値は true です。	いいえ
validateSigningKey	トークン署名の検証を無効にするには、 false に設定します。 既定true	いいえ

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

なし