OAuth2Authorizer

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

Para mais informações, consulte Controlar o acesso a APIs HTTP 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.

YAML

  AuthorizationScopes: List
  IdentitySource: String
  JwtConfiguration: Map

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.

Tipo: 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

Autorizador OAuth 2.0

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