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

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

OAuth2Authorizer

2.0 授权方的定义,也称为 JSON Web 令牌 (JWT) 授权方。OAuth

有关更多信息,请参阅 中的APIs使用 JWT 授权方控制对 HTTP 的访问。API 网关 开发人员指南

语法

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

属性

AuthorizationScopes

此授权方的授权范围列表。

类型:列表

必需: 否

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

IdentitySource

此授权方的身份源表达式。

类型: 字符串

必需: 否

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

JwtConfiguration

此授权方的 JWT 配置。

这将传递到 jwtConfiguration 定义的 x-amazon-apigateway-authorizer 部分中的 securitySchemes 的 OpenAPI 部分。

类型:Map

必需: 否

兼容性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