HttpApiAuth - AWS Serverless Application Model
语法属性示例
AWS 文档中描述的 AWS 服务或功能可能因区域而异。要查看适用于中国区域的差异，请参阅中国的 AWS 服务入门。

本文属于机器翻译版本。若本译文内容与英语原文存在差异，则一律以英文原文为准。

HttpApiAuth

配置授权以控制对您的 API 网关 API。

有关配置访问的详细信息,请参阅 JWT授权人 在 API 网关 开发者指南。

语法

在你的 AWS 无服务器应用程序模型 (AWS SAM)模板,使用以下语法。

属性

Authorizers

授权人用于控制对您的 API 网关 API。

类型: OAuth2授权者

必需: 否

默认值：无

AWS CloudFormation 相容性: 此属性对于 AWS SAM 并且没有 AWS CloudFormation 同等产品。

其他备注: SAM将授权者添加到Api的OpenApi定义中。

DefaultAuthorizer

为 API 网关 API,用于默认授权API调用。

类型：字符串

必需: 否

默认值：无

AWS CloudFormation 相容性: 此属性对于 AWS SAM 并且没有 AWS CloudFormation 同等产品。

示例

OAuth2授权者

OAuth2授权程序示例

YAML

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