

# x-amazon-apigateway-auth オブジェクト
<a name="api-gateway-swagger-extensions-auth"></a>

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


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

## x-amazon-apigateway-auth の例
<a name="api-gateway-swagger-extensions-auth-example"></a>

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

------
#### [ OpenAPI 3.0.1 ]

```
{
  "openapi": "3.0.1",
  "info": {
    "title": "openapi3",
    "version": "1.0"
  },
  "paths": {
    "/protected-by-iam": {
      "get": {
        "x-amazon-apigateway-auth": {
          "type": "AWS_IAM"
        }
      }
    }
  }
}
```

------