Condividi tramite


AuthPlugin

Simula l'autenticazione e l'autorizzazione usando le chiavi API o OAuth2.

Screenshot di un prompt dei comandi con Dev Proxy che simula l'autenticazione usando la chiave API in una funzione di Azure in esecuzione in locale.

Definizione dell'istanza del plug-in

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

Esempio di configurazione: chiave API

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

Esempio di configurazione: 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
    }
  }
}

Proprietà di configurazione

Proprietà Descrizione Richiesto
type Tipo di autenticazione e autorizzazione che deve essere usato da Dev Proxy. Valori consentiti: apiKey, oauth2
apiKey Configurazione per l'autenticazione e l'autorizzazione della chiave API. Sì, quando type è apiKey
oauth2 Configurazione per l'autenticazione e l'autorizzazione di OAuth2. Sì, quando type è oauth2

Proprietà di configurazione della chiave API

Proprietà Descrizione Richiesto
allowedKeys Elenco delle chiavi API consentite.
parameters Elenco di parametri che contengono la chiave API.

Proprietà di configurazione dei parametri

Proprietà Descrizione Richiesto
in Dove si prevede che venga trovato il parametro . Valori consentiti: header, query, cookie
name Nome del parametro.

Proprietà di configurazione OAuth2

Proprietà Descrizione Richiesto
metadataUrl URL del documento di metadati OpenID Connect.
allowedApplications Elenco degli ID applicazione consentiti. Lasciare vuoto per non convalidare l'applicazione (appid o azp l'attestazione) per cui viene emesso il token. No
allowedAudiences Elenco di gruppi di destinatari consentiti. Lasciare vuoto per non convalidare il gruppo di destinatari (aud attestazione) per cui viene rilasciato il token. No
allowedPrincipals Elenco di entità consentite. Lasciare vuoto per non convalidare l'entità (oid attestazione) per cui viene emesso il token. No
allowedTenants Elenco di tenant consentiti. Lasciare vuoto per non convalidare il tenant (tid attestazione) per il quale viene emesso il token. No
issuer Autorità emittente di token consentita. Lasciare vuoto per non convalidare l'autorità emittente del token. No
roles Elenco dei ruoli consentiti. Lasciare vuoto per non convalidare i ruoli (roles attestazione) nel token. No
scopes Elenco di ambiti consentiti. Lasciare vuoto per non convalidare gli ambiti (scp attestazione) nel token. No
validateLifetime Impostare su per false disabilitare la convalida della durata del token. Valore predefinito true. No
validateSigningKey Impostare su false per disabilitare la convalida della firma del token. Default true No

Opzioni della riga di comando

Nessuno