AuthPlugin

Simula la autenticación y autorización mediante claves de API o OAuth2.

Definición de instancia del complemento

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

Ejemplo de configuración: clave de API

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

Ejemplo de configuración: 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
    }
  }
}

Propiedades de configuración

Propiedad	Descripción	Obligatorio
type	Tipo de autenticación y autorización que debe usar el proxy de desarrollo. Valores permitidos: apiKey, oauth2	Sí
apiKey	Configuración para la autenticación y autorización de claves de API.	Sí, cuando type es apiKey
oauth2	Configuración de la autenticación y autorización de OAuth2.	Sí, cuando type es oauth2

Propiedades de configuración de clave de API

Propiedad	Descripción	Obligatorio
allowedKeys	Lista de claves de API permitidas.	Sí
parameters	Lista de parámetros que contienen la clave de API.	Sí

Propiedades de configuración de parámetros

Propiedad	Descripción	Obligatorio
in	Donde se espera que se encuentre el parámetro. Valores permitidos: header, query y cookie	Sí
name	Nombre del parámetro.	Sí

Propiedades de configuración de OAuth2

Propiedad	Descripción	Obligatorio
metadataUrl	Dirección URL del documento de metadatos de OpenID Connect.	Sí
allowedApplications	Lista de identificadores de aplicación permitidos. Deje vacío para no validar la aplicación (appid o azp notificación) para la que se emite el token.	No
allowedAudiences	Lista de audiencias permitidas. Deje vacío para no validar la audiencia (aud notificación) para la que se emite el token.	No
allowedPrincipals	Lista de entidades de seguridad permitidas. Deje vacío para no validar la entidad de seguridad (oid notificación) para la que se emite el token.	No
allowedTenants	Lista de inquilinos permitidos. Deje vacío para no validar el inquilino (tid notificación) para el que se emite el token.	No
issuer	Emisor de tokens permitido. Deje vacío para no validar el emisor del token.	No
roles	Lista de roles permitidos. Deje vacío para no validar los roles (roles notificación) en el token.	No
scopes	Lista de ámbitos permitidos. Deje vacío para no validar los ámbitos (scp notificación) en el token.	No
validateLifetime	Establézcalo en false para deshabilitar la validación de la duración del token. El valor predeterminado es true.	No
validateSigningKey	Establézcalo en false para deshabilitar la validación de la firma del token. true predeterminado	No

Opciones de línea de comandos

Ninguno