OAuth2Authorizer

OAuth 2.0 授权方的定义，也称为 JSON Web 令牌（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 等效属性。

示例

OAuth 2.0 授权方

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