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

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

HttpApiAuth

配置授权以控制对 Amazon API Gateway HTTP API 的访问。

有关配置对 HTTP APIs 的访问权限的更多信息,请参阅 中的API 网关在 中控制和管理对 HTTP API 的访问。API 网关 开发人员指南

语法

在您的 中声明此实体 AWS 无服务器应用程序模型 (AWS SAM) 模板时,请使用以下语法。

属性

Authorizers

用于控制对您的 API 网关 API 的访问的授权方。

类型: OAuth2Authorizer | LambdaAuthorizer

必需: 否

默认值:无

兼容性AWS CloudFormation:此属性对于 AWS SAM 是唯一的,没有等效的 AWS CloudFormation。

其他说明:AWS SAM 将授权方添加到 OpenAPI 定义。

DefaultAuthorizer

指定用于授权对 API 网关 API 的 API 调用的默认授权方。

类型:字符串

必需: 否

默认值:无

兼容性AWS CloudFormation:此属性对于 AWS SAM 是唯一的,没有等效的 AWS CloudFormation。

示例

OAuth 2.0 授权方

OAuth 2.0 授权方示例

YAML

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