メニュー
Amazon API Gateway
開発者ガイド

x amazon-apigateway-authtype プロパティ

カスタム承認のタイプを指定します。これは API Gateway API のインポートおよびエクスポート機能で解析されます。

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

x-amazon-apigateway-authtype の例

次の例では、OAuth 2 を使用してカスタム認証のタイプを設定します。

Copy
"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 を使用して認証を指定します。

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

このページの内容: