Client ID Interceptor - getheimdall/heimdall GitHub Wiki

Definition

The Client Id interceptor is used to check if the request send the Client Id that is registered for the Api. For this interceptor to work an App needs to be created in Heimdall and added to a Plan that is associated to the Api.

Details

Name: Simple name for your interceptor

Description: A simple description for your interceptor

Life Cycle: The appropriate life cycle for the interceptor

• Life cycles allowed:
  • Api
  • Resource
  • Operation

Content: Configuration of the interceptor

JSON example:

{
  "location": "HEADER",
  "name": "client_id"
}

location: where in the request the client id will be sent. Allowed values: HEADER, QUERY_PARAM

name: name of the key for the client id