OAuth2Authorizer - AWS Serverless Application Model
SintaxisPropiedadesEjemplos

OAuth2Authorizer

Definición de OAuth 2.0, también conocido como un JSON Web Token (JWT).

Para obtener más información, consulta Control del acceso a las API HTTP con autorizadores de JWT en la Guía para desarrolladores de API Gateway.

Sintaxis

Para declarar esta entidad en su plantilla de AWS Serverless Application Model (AWS SAM), usa la siguiente sintaxis:

Propiedades

AuthorizationScopes

Lista de los ámbitos de autorización de este autorizador.

Tipo: lista

Obligatorio: no

Compatibilidad con CloudFormation: esta propiedad es exclusiva de AWS SAM y no tiene un equivalente CloudFormation.

IdentitySource

Expresión de origen de identidad para este autorizador.

Tipo: cadena

Obligatorio: no

Compatibilidad con CloudFormation: esta propiedad es exclusiva de AWS SAM y no tiene un equivalente CloudFormation.

JwtConfiguration

Configuración JWT para este autorizador.

Esto se transfiere a la sección jwtConfiguration de un x-amazon-apigateway-authorizer en la sección securitySchemes de la definición de OpenAPI.

nota

Las propiedades issuer y audience no distinguen entre mayúsculas y minúsculas y se pueden usar en minúsculas, como en OpenAPI, o en mayúsculas, Issuer y Audience como en AWS::APIGatewayV2::Authorizer.

Tipo: mapa

Obligatorio: no

Compatibilidad con CloudFormation: esta propiedad es exclusiva de AWS SAM y no tiene un equivalente CloudFormation.

Ejemplos

Autorizador de OAuth 2.0

Ejemplo de autorizadores de OAuth 2.0

YAML

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