AuthPlugin

Simuleert verificatie en autorisatie met behulp van API-sleutels of OAuth2.

Definitie van invoegtoepassingexemplaren

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

Configuratievoorbeeld: API-sleutel

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

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

Configuratie-eigenschappen

Eigenschappen	Beschrijving	Vereist
type	Type verificatie en autorisatie dat dev proxy moet gebruiken. Toegestane waarden: apiKey, oauth2	Ja
apiKey	Configuratie voor verificatie en autorisatie van API-sleutels.	Ja, wanneer type is apiKey
oauth2	Configuratie voor OAuth2-verificatie en -autorisatie.	Ja, wanneer type is oauth2

Configuratie-eigenschappen van API-sleutel

Eigenschappen	Beschrijving	Vereist
allowedKeys	Lijst met toegestane API-sleutels.	Ja
parameters	Lijst met parameters die de API-sleutel bevatten.	Ja

Eigenschappen van parameterconfiguratie

Eigenschappen	Beschrijving	Vereist
in	Waar de parameter naar verwachting wordt gevonden. Toegestane waarden: header, querycookie	Ja
name	Naam van de parameter.	Ja

OAuth2-configuratie-eigenschappen

Eigenschappen	Beschrijving	Vereist
metadataUrl	URL naar het openID Connect-metagegevensdocument.	Ja
allowedApplications	Lijst met toegestane toepassings-id's. Laat leeg om de toepassing (appid of azp claim) waarvoor het token is uitgegeven, niet te valideren.	Nee
allowedAudiences	Lijst met toegestane doelgroepen. Laat leeg om de doelgroep (aud claim) waarvoor het token is uitgegeven, niet te valideren.	Nee
allowedPrincipals	Lijst met toegestane principals. Laat leeg om de principal (oid claim) waarvoor het token is uitgegeven, niet te valideren.	Nee
allowedTenants	Lijst met toegestane tenants. Laat leeg om de tenant (tid claim) waarvoor het token is uitgegeven, niet te valideren.	Nee
issuer	Toegestane tokenverlener. Laat leeg om de tokenuitgever niet te valideren.	Nee
roles	Lijst met toegestane rollen. Laat leeg om de rollen (roles claim) op het token niet te valideren.	Nee
scopes	Lijst met toegestane bereiken. Laat leeg om de bereiken (scp claim) op het token niet te valideren.	Nee
validateLifetime	Ingesteld om false het valideren van de levensduur van het token uit te schakelen. Standaard true.	Nee
validateSigningKey	Ingesteld om false het valideren van de tokenhandtekening uit te schakelen. Verstek true	Nee

Opdrachtregelopties

Geen