Skip to main content
Feedback

Design and Implementation

Sequence Diagram

Implementation Details

  • If the connector is used as an Authenticator, the Whitelist IP Range and Whitelist IP list are retrieved either from service key or package key EAVs.

  • If the connector is used as a Processor, Whitelist IP Range and Whitelist IP list are retrieved from pre-inputs.

  • The requesting IP and retrieved Whitelist IP List/Range are passed to the IP Whitelist Service to check whether the requesting IP exists in the Whitelisted IP list/Range.

  • If the requesting IP exists in the list/range, a request is sent to the backend.

  • If the requesting IP is not authenticated, then a Not Authorized error is sent back to the user client.

When to use Connector as an Authenticator vs. Processor

The Connector can be used as an Authenticator to augment API key with IP Whitelisting. The Connector can also be used as a processor. A natural question comes into mind when to use this Connector as an Authenticator vs Processor. Here are few tips about business cases that might benefit from this Connector.

Use as an Authenticator

  • When you need to bind IP whitelisting policy to a specific Package key or API key.

  • API Management allows you to configure Package key level EAV (Custom Attribute Value) that binds to a particular package key. Refer to Using the Connector as an Authenticator for more information.

Use as a Processor

On this Page