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

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

OAuth2Authorizer

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

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

语法

要在您的中声明此实体Amazon Serverless Application Model(Amazon SAM) 模板,请使用以下语法。

属性

AuthorizationScopes

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

类型:List

必需:否

Amazon CloudFormation兼容性:此属性是唯一的Amazon SAM而且没有Amazon CloudFormation等效项

IdentitySource

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

类型:字符串

必需:否

Amazon CloudFormation兼容性:此属性是唯一的Amazon SAM而且没有Amazon CloudFormation等效项

JwtConfiguration

此授权者的 JWT 配置。

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

类型:Map

必需:否

Amazon CloudFormation兼容性:此属性是唯一的Amazon SAM而且没有Amazon 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