Basic Ruleset Example
When there is a need to give different API clients access to all Endpoints and operations within certain APIs, only one Ruleset for the API is needed.
Below is a screenshot of a Ruleset for this kind of common scenario:
β
This Ruleset gives access to any Endpoint path starting with /api/time/v1 for the API Keys, linked to this Ruleset.
β
In the Time API v1, there is only one Endpoint, GET /api/time/v1/now. Access to this Endpoint path could also be given like this:
β
If you grant access by defining the precise HTTP method and also the individual Endpoint paths, you need to remember to add all possible new Endpoints to the Ruleset.
In case of APIs requiring high information security, it is a good idea to grant access by adding all the individual allowed HTTP method and API Paths to prevent accidental access to any new API operation.
The next article is Example on Ruleset with different access for different API consumer types