OAuth2Authorizer

OAuth 2.0 授權者的定義，也稱為 JSON 網絡令牌（JWT）授權者。

如需詳細資訊，請參閱《API Gateway 開發人員指南》中的使用 JWT 授權方控制對 HTTP API 的存取。

語法

若要在 AWS Serverless Application Model (AWS SAM) 範本中宣告此實體，請使用下列語法。

YAML

  AuthorizationScopes: List
  IdentitySource: String
  JwtConfiguration: Map

屬性

AuthorizationScopes

此授權者的授權範圍清單。

類型：清單

必要：否

AWS CloudFormation 兼容性：此屬性是唯一的， AWS SAM 並且沒有相 AWS CloudFormation 等的屬性。

IdentitySource

此授權者的識別來源運算式。

類型：字串

必要：否

AWS CloudFormation 兼容性：此屬性是唯一的， AWS SAM 並且沒有相 AWS CloudFormation 等的屬性。

JwtConfiguration

此授權者的 JWT 設定。

這會傳遞至 OpenAPI 定義一securitySchemes節x-amazon-apigateway-authorizer中的一節。jwtConfiguration

注意

屬性issuer和audience不區分大小寫，可以在 OpenAPI 中使用小寫字母或大寫字母Issuer和Audience。AWS::ApiGatewayV2::Authorizer

類型：地圖

必要：否

AWS CloudFormation 兼容性：此屬性是唯一的， AWS SAM 並且沒有相 AWS CloudFormation 等的屬性。

範例

驗證 2.0 授權者

驗證 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