Menu
Amazon API Gateway
Developer Guide

x-amazon-apigateway-authtype Property

Specify the type of a custom authorizer. It is parsed by the API Gateway API import and export features.

This property is an extended property of the Swagger Security Definitions Operation object.

x-amazon-apigateway-authtype Example

The following example sets the type of a custom authorizer using 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" : { ... } }

The following security definition example specifies authorization using AWS Signature Version 4:

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