OAuth2Authorizer

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

Para obtener más información, consulte 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 suAWS Serverless Application Model(AWS SAM), utilice la siguiente sintaxis.

YAML

  AuthorizationScopes: List
  IdentitySource: String
  JwtConfiguration: Map

Properties

AuthorizationScopes

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

Type: Lista

Obligatorio: No

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

IdentitySource

Expresión de origen de identidad para este autorizador.

Type: Cadena

Obligatorio: No

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

JwtConfiguration

Configuración de JWT para este autorizador.

Esto se pasa a través de lajwtConfigurationsección sobre de unx-amazon-apigateway-authorizeren lasecuritySchemessección sobre de una definición de OpenAPI.

Type: Mapeo

Obligatorio: No

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

Ejemplos

Autorizador OAuth 2.0

Ejemplo de autorizador 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