Amazon API Gateway
開発者ガイド

x-amazon-apigateway-auth オブジェクト

API Gateway でのメソッド呼び出しの認証に適用する認証タイプを定義します。

プロパティ

プロパティ名 タイプ 説明
type string 認証タイプを指定します。オープンアクセスに対して "NONE" を指定します。IAM アクセス許可を使用するように "AWS_IAM" を指定します。値では大文字と小文字は区別されません。

x-amazon-apigateway-auth の例

次の例では、REST API メソッドの認証タイプを設定します。

OpenAPI 3.0.1
OpenAPI 3.0.1
{ "openapi": "3.0.1", "info": { "title": "openapi3", "version": "2018-12-04T05:22:50Z" }, "servers": [ { "url": "https://hs8l62bm7l.execute-api.us-west-2.amazonaws.com/{basePath}", "variables": { "basePath": { "default": "/dev" } } } ], "security": [ { "api_key": [] } ], "paths": { "/key": { "get": { "x-amazon-apigateway-auth": { "type": "NONE" }, "security": [ { "api_key": [] } ] } } }, "components": { "securitySchemes": { "api_key": { "type": "apiKey", "name": "x-api-key", "in": "header" } } } }

このページの内容: