InboundProfiles

Summary

Inbound profiles

Description

The inbound profile provides configuration for the frontend. The _default profile applies to all inbound API calls. However, methods may be overridden using the InboundProfiles.

The inbound profile overrides are used as part of the VirtualizedAPI definition and alters the normal API proxy behavior, allowing complete control over the frontend. Using the InboundProfiles, it is possible to enforce frontend security by setting securityProfile to the name of a configured SecurityProfile. Monitoring for the API may be enabled/disabled using monitorAPI. The subject (client) for monitoring can be obtained from any message attribute, and can be changed using monitorSubject. In addition, CORS settings can be set using the corsProfile.

Fields

Field Name Type Since Version Description
securityProfile String The name of the Security Profile to be used for this Virtualized API.
corsProfile String The name of the CORS Profile to be used for this Virtualized API.
monitorAPI Boolean Enables metrics monitoring for the API
monitorSubject String Identifies the client for metrics monitoring

Example JSON

{
  "securityProfile" : "Default Inbound Security",
  "corsProfile" : "Default CORS profile",
  "monitorAPI" : true,
  "monitorSubject" : "authentication.subject.id"
}