Amazon API Gateway
開発者ガイド

x amazon-apigateway-authtype プロパティ

必要に応じて、Lambda オーソライザー (以前のカスタムオーソライザー) を説明するお客様定義の情報を指定します。これは API Gateway API のインポートおよびエクスポートに使用されるもので、機能には影響しません。

このプロパティは、Swagger Security Definitions Operation オブジェクトの拡張プロパティです。

x-amazon-apigateway-authtype の例

次の例では、OAuth 2 を使用して Lambda オーソライザーのタイプを設定します。

"cust-authorizer" : { "type" : "...", // required "name" : "...", // name of the identity source header "in" : "header", // must be header "x-amazon-apigateway-authtype" : "oauth2", // Specifies the authorization mechanism for the client. "x-amazon-apigateway-authorizer" : { ... } }

以下のセキュリティ定義の例では、AWS 署名バージョン 4 を使用して認証を指定します。

"sigv4" : { "type" : "apiKey", "name" : "Authorization", "in" : "header", "x-amazon-apigateway-authtype" : "awsSigv4" }

以下の資料も参照してください。

authorizer.authType