AuthPlugin

Simulerar autentisering och auktorisering med hjälp av API-nycklar eller OAuth2.

Definition av plugin-instans

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

Konfigurationsexempel: API-nyckel

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

Konfigurationsexempel: 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
    }
  }
}

Konfigurationsegenskaper

Property	Beskrivning	Obligatoriskt
type	Typ av autentisering och auktorisering som Dev Proxy ska använda. Tillåtna värden: apiKey, oauth2	Ja
apiKey	Konfiguration för API-nyckelautentisering och auktorisering.	Ja, när type är apiKey
oauth2	Konfiguration för OAuth2-autentisering och auktorisering.	Ja, när type är oauth2

Konfigurationsegenskaper för API-nyckel

Property	Beskrivning	Obligatoriskt
allowedKeys	Lista över tillåtna API-nycklar.	Ja
parameters	Lista över parametrar som innehåller API-nyckeln.	Ja

Egenskaper för parameterkonfiguration

Property	Beskrivning	Obligatoriskt
in	Där parametern förväntas hittas. Tillåtna värden: header, query, cookie	Ja
name	Namn på parameter.	Ja

Konfigurationsegenskaper för OAuth2

Property	Beskrivning	Obligatoriskt
metadataUrl	URL till openID Connect-metadatadokumentet.	Ja
allowedApplications	Lista över tillåtna program-ID:t. Lämna tomt för att inte verifiera programmet (appid eller azp anspråket) som token har utfärdats för.	Nej
allowedAudiences	Lista över tillåtna målgrupper. Lämna tomt för att inte verifiera målgruppen (aud anspråket) som token har utfärdats för.	Nej
allowedPrincipals	Lista över tillåtna huvudnamn. Lämna tomt för att inte verifiera det huvudnamn (oid anspråk) som token har utfärdats för.	Nej
allowedTenants	Lista över tillåtna klienter. Lämna tomt för att inte verifiera klientorganisationen (tid anspråket) som token har utfärdats för.	Nej
issuer	Tillåten token utfärdare. Lämna tomt för att inte verifiera token utfärdaren.	Nej
roles	Lista över tillåtna roller. Låt vara tomt för att inte verifiera rollerna (roles anspråket) på token.	Nej
scopes	Lista över tillåtna omfång. Lämna tomt för att inte verifiera omfången (scp anspråket) på token.	Nej
validateLifetime	Ange till för att false inaktivera validering av tokenlivslängden. Standard true.	Nej
validateSigningKey	Ange till för att false inaktivera validering av tokensignaturen. Standard true	Nej

Kommandoradsalternativ

Ingen