Menu
Amazon API Gateway
Developer Guide

x-amazon-apigateway-authtype Property

Specify an optional customer-defined information describing a Lambda authorizer (formerly known as a custom authorizer). It is used for API Gateway API import and export without functional impact.

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 Lambda authorizer using OAuth 2.

"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:

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

See Also

authorizer.authType