OAuth2Authorizer - AWS Serverless Application Model
構文プロパティ例

OAuth2Authorizer

JSON Web トークン (JWT) オーソライザーとしても知られる OAuth 2.0 オーソライザーの定義です。

詳細については、API Gateway デベロッパーガイドの「JWT オーソライザーを使用した HTTP API へのアクセスの制御」を参照してください。

構文

AWS Serverless Application Model (AWS SAM) テンプレートでこのエンティティを宣言するには、以下の構文を使用します。

プロパティ

AuthorizationScopes

このオーソライザーの認可スコープのリストです。

タイプ: リスト

必須: いいえ

CloudFormation との互換性: このプロパティは AWS SAM に固有であり、CloudFormation に同等のものはありません。

IdentitySource

このオーソライザーのアイデンティティソース式です。

タイプ: 文字列

必須: いいえ

CloudFormation との互換性: このプロパティは AWS SAM に固有であり、CloudFormation に同等のものはありません。

JwtConfiguration

このオーソライザーの JWT 設定です。

これは、OpenAPI 定義の securitySchemes セクションにある x-amazon-apigateway-authorizer の jwtConfiguration セクションに渡されます。

注記

プロパティ issuer と audience は大文字と小文字を区別せず、OpenAPI のように小文字を使用することも、 AWS::ApiGatewayV2::Authorizer のように大文字の Issuer および Audience を使用することもできます。

タイプ: マップ

必須: いいえ

CloudFormation との互換性: このプロパティは AWS SAM に固有であり、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