OAuth2Authorizer - AWS Serverless Application Model
SyntaxEigenschaftenBeispiele

Die vorliegende Übersetzung wurde maschinell erstellt. Im Falle eines Konflikts oder eines Widerspruchs zwischen dieser übersetzten Fassung und der englischen Fassung (einschließlich infolge von Verzögerungen bei der Übersetzung) ist die englische Fassung maßgeblich.

OAuth2Authorizer

Definition für einen OAuth 2.0-Authorizer, auch bekannt als JSON Web Token (JWT) -Authorizer.

Weitere Informationen finden Sie unter Controlling access to HTTP APIs with JWT authorizers (Zugriffskontrolle auf HTTP-APIs mit JWT-Autorisierern) im Entwicklerhandbuch von API Gateway.

Syntax

Verwenden Sie die folgende Syntax, um diese Entität in Ihrer Vorlage AWS Serverless Application Model (AWS SAM) zu deklarieren.

Eigenschaften

AuthorizationScopes

Liste der Autorisierungsbereiche für diesen Autorisierer.

Typ: Liste

Required: No

AWS CloudFormation Kompatibilität: Diese Eigenschaft ist einzigartig für AWS SAM und hat kein AWS CloudFormation Äquivalent.

IdentitySource

Ausdruck der Identitätsquelle für diesen Autorisierer.

Typ: Zeichenfolge

Required: No

AWS CloudFormation Kompatibilität: Diese Eigenschaft ist einzigartig für AWS SAM und hat kein AWS CloudFormation Äquivalent.

JwtConfiguration

JWT-Konfiguration für diesen Autorisierer.

Dies wird an den jwtConfiguration Abschnitt von und x-amazon-apigateway-authorizer im securitySchemes Abschnitt einer OpenAPI-Definition weitergegeben.

Anmerkung

Eigenschaften issuer und audience unterscheiden nicht zwischen Groß- und Kleinschreibung und können entweder in Kleinbuchstaben wie in OpenAPI oder in Großbuchstaben Issuer und wie in verwendet werden. Audience AWS::ApiGatewayV2::Authorizer

Typ: Karte

Required: No

AWS CloudFormation Kompatibilität: Diese Eigenschaft ist einzigartig für AWS SAM und hat kein AWS CloudFormation Äquivalent.

Beispiele

OAuth 2.0-Autorisierer

Beispiel für einen OAuth 2.0-Authorizer

YAML

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