IP Access Control

When to use

Use this policy when you want to control the access to requests based on IP address from which they are originated.

Details

The Access Control policy serves not only to safeguard your APIs from malicious IP addresses but also to grant you authority over legitimate IP access. It enables you to exert control over which IP addresses are permitted to access your APIs.

For instance, if you wish to restrict access to the APIs in your test environment exclusively to computers within your enterprise, you can allow access only from the IP address range associated with your internal network. In situations where developers are working remotely from home, they can still access these APIs by connecting through a Virtual Private Network (VPN), ensuring secure and authorized access from outside the internal network.

Configuration

The configuration fields for the policy are:

[* Indicates a mandatory field]

Name *: Display name of the policy

Description: Description of policy

Enabled: Flag to indicate if the policy is enabled. If this field is not checked, the policy will be ignored at runtime and any fields from its output will contain a default initial value

Continue on Error: Flag to indicate that the flow should continue even if this policy throws an error

Action: The value can be ‘Allow’ or ‘Deny’. In case the value is ‘Allow’ only IPs that match the IP address and IP mask will be allowed. If the action is ‘Deny’, then the IPs that match IP address and IP Mask are denied.

IP Address: IP address which will be identified

IP Mask: The mask attribute is a way to indicate the range of IP addresses to allow or deny. Mask is the equivalent of using CIDR notation (Classless Inter-Domain Routing). For example:

IP Address 198.50.100.1 with mask=24 is equivalent to the following CIDR notation:

198.50.100.1/24

Valid values:

IPv4: 1-32

IPv4: 1-238

Input fields

None

Output fields

isValid: Returns a boolean true if the api key is valid and access is allowed to the request

blockedAddress: IP address that is blocked for any request