SecurityProfile

Summary

Inbound security profile.

Description

Provides support for inbound security mechanisms. The profile has a list of ordered SecurityDevice. During inbound authentication, the list of SecurityDevice are checked in sequence. The first that succeeds will permit the API method to be invoked. If no security device passes, the API invocation is not permitted.

Fields

Field Name	Type	Since Version	Description
devices	[SecurityDevice]		List of SecurityDevice for this security profile
name	String		Unique name of the Profile
isDefault	Boolean		Indicates that this is the default profile. There can be only one default.

Example JSON

{
  "name" : "Default Security Profile",
  "isDefault" : false,
  "devices" : [ {
    "name" : "My Pass-through Device",
    "type" : "apiKey",
    "order" : 1,
    "properties" : {
      "apiKeyFieldName" : "APIKey",
      "takeFrom" : "HEADER"
    }
  } ]
}