SecurityDevice

Summary

Inbound security device.

Description

The inbound security device is used with the SecurityProfile to define an inbound security requirement for an API.

Fields

Field Name Type Since Version Description
name String Unique name of the Security Device.
type String The Security device type. Values are one of: apiKey, awsHeader, awsQuery, basic, twoWaySSL, oauth, or passThrough.
order Int Specifies the orider in which this device will be invoked.
properties {String, String} List of device-specific properties.

Example JSON

{
  "name" : "My Pass-through Device",
  "type" : "apiKey",
  "order" : 1,
  "properties" : {
    "apiKeyFieldName" : "APIKey",
    "takeFrom" : "HEADER"
  }
}