OAuth2Authorizer - AWS Serverless Application Model
SintaxePropriedadesExemplos

As traduções são geradas por tradução automática. Em caso de conflito entre o conteúdo da tradução e da versão original em inglês, a versão em inglês prevalecerá.

OAuth2Authorizer

Definição para um autorizador OAuth 2.0, também conhecido como autorizador JSON Web Token (JWT).

Para obter mais informações, consulte Controle do acesso ao HTTP APIs com autorizadores JWT no Guia do desenvolvedor do API Gateway.

Sintaxe

Para declarar essa entidade em seu modelo AWS Serverless Application Model (AWS SAM), use a sintaxe a seguir.

Propriedades

AuthorizationScopes

Lista de escopos de autorização para esse autorizador.

Tipo: lista

Obrigatório: não

AWS CloudFormation compatibilidade: essa propriedade é exclusiva AWS SAM e não tem AWS CloudFormation equivalente.

IdentitySource

Expressão da fonte de identidade para esse autorizador.

Type: string

Obrigatório: não

AWS CloudFormation compatibilidade: essa propriedade é exclusiva AWS SAM e não tem AWS CloudFormation equivalente.

JwtConfiguration

Configuração do JWT para esse autorizador.

Isso é passado para a seção jwtConfiguration de um x-amazon-apigateway-authorizer na seção securitySchemes de uma definição de OpenAPI.

nota

As propriedades issuer e audience não diferenciam maiúsculas e minúsculas e podem ser usadas em minúsculas, como na OpenAPI, ou em maiúsculas, como em. Issuer Audience AWS::ApiGatewayV2::Authorizer

Tipo: mapa

Obrigatório: não

AWS CloudFormation compatibilidade: essa propriedade é exclusiva AWS SAM e não tem AWS CloudFormation equivalente.

Exemplos

OAuth Autorizador 2.0

OAuth Exemplo de autorizador 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