HttpApiAuth - AWS Serverless Application Model
SintaxisPropertiesEjemplos

Las traducciones son generadas a través de traducción automática. En caso de conflicto entre la traducción y la version original de inglés, prevalecerá la version en inglés.

HttpApiAuth

Configuración de la autorización para controlar el acceso a su API HTTP de Amazon API Gateway.

Para obtener más información acerca de la configuración del acceso a las API HTTP, consulteControl y administración del acceso a una API HTTP en API Gatewayen laGuía para desarrolladores API Gateway.

Sintaxis

Para declarar esta entidad en suAWS Serverless Application Model(AWS SAM), utilice la siguiente sintaxis.

Properties

Authorizers

El autorizador utilizado para controlar el acceso a su API API Gateway.

Type: Auth2 Auth2|Autorizador Lambda

Obligatorio: No

Valor predeterminado: Ninguno

AWS CloudFormationcompatibilidad: Esta propiedad es específica deAWS SAMy no tieneAWS CloudFormationequivalente.

Notas adicionales:AWS SAMañade los autorizadores a la definición de OpenAPI.

DefaultAuthorizer

Especifique el autorizador predeterminado que se utilizará para autorizar llamadas a API a la API de API Gateway.

Type: Cadena

Obligatorio: No

Valor predeterminado: Ninguno

AWS CloudFormationcompatibilidad: Esta propiedad es específica deAWS SAMy no tieneAWS CloudFormationequivalente.

Ejemplos

Autorizador OAuth 2.0

Ejemplo de autorizador de OAuth 2.0

YAML

Auth:
  Authorizers:
    OAuth2Authorizer:
      AuthorizationScopes:
        - scope1
        - scope2
      JwtConfiguration:
        issuer: "https://www.example.com/v1/connect/oauth2"
        audience:
          - MyApi
      IdentitySource: "$request.querystring.param"
  DefaultAuthorizer: OAuth2Authorizer