Protecting APIs on Apigee Edge Gateway
Instructions on how to discover, integrate and protect your APIs deployed behind the Apigee Edge gateway.
Docker and Docker Compose
Access to an ACP tenant
Apigee Edge account with an active organization
Apigee Edge Authorizer has two features which require access to Apigee Edge API.
API discovery works by grouping and converting a list of Apigee Edge products into a format required by ACP. The product list is obtained from the Apigee Edge API. To make it work, the configured user must have access to the product list.
Shared Flow installation
Shared flow installation works by uploading a compressed package to Apigee Edge. If the shared flow already exist, a new revision is created. To make it work, the configured user must have a built-in
Apigee Edge and SAML
Apigee Edge Authorizer, with its API discovery capabilities and a possibility to install a shared flow within your Apigee Gateway instance, exists with your Apigee Edge instance in a machine to machine environment. The authorizer does the automation for you. Because of that, when SAML is enabled for your Apigee Edge Gateway, it is not possible to use traditional password flow for SAML users to obtain OAuth2 access and refresh tokens.
To make it possible for you to authenticate your machine (in this
case, the Apigee Edge Authorizer) when using SAML, Apigee Edge introduces the concept of machine
users. Such users can obtain OAuth2 tokens for your authorizer without a need to specify a passcode
and they are stored within your Edge datastore, not your SAML identity provider. You can limit
access for such users, but make sure that the user you create for authorizer’s needs has access to
the product list and has the
Organization Administrator role built-in. Credentials of your
machine user are later on provided in your authorizer’s
You can learn more about machine users and how to create them in Using SAML with automated tasks Apigee Edge documentation
Create Apigee Edge gateway
Log in to your ACP tenant.
Open your authorization server (workspace).
Go to Enforcement -> Authorizers.
Select Add Gateway. A list of available gateways appears.
Select Apigee Edge. Provide the name and description.
Optionally, enable the Create and bind services automatically check box.
When enabled, all services protected by your Apigee Edge instance are discovered and added to the ACP service list automatically when the Apigee authorizer is connected to ACP. Otherwise, you need to add them manually.
Follow the Quick Start instruction. Download the package from your tenant and check the Integrate ACP and Apigee Edge instructions.
Integrate ACP and Apigee Edge Authorizer
Unzip the package and open the
Edit the following parameters to match your Apigee Edge instance:
username- replace with your username
password- replace with your password
org-id- replace with your organization ID
version: '3' services: apigee-authorizer: container_name: apigee-edge-authorizer image: docker.cloudentity.io/apigee-authorizer:1.13.0 env_file: .authorizer_env environment: - APIGEE.APIGEE_PRODUCT=ApigeeEdge - APIGEE.ACP_RELOAD_INTERVAL=5s # for demo purposes only, increase for production! - APIGEE.APIGEE_EDGE.USERNAME=username - APIGEE.APIGEE_EDGE.PASSWORD=password - APIGEE.APIGEE_EDGE.ORGANIZATION_ID=org-id ports: - 8442:8442 restart: on-failure
APIGEE.ACP_RELOAD_INTERVALconfiguration parameter defines how often ACP tries to discover APIs on your gateway.
Save your changes when done.
docker-compose run apigee-authorizer installcommand in your terminal.
When you run the command, a shared Authorizer flow is created automatically for you in your Apigee Edge instance. The shared flow consists of two policies:
An XML Raise Authorization Error policy that is responsible for delivering the error status as the response to the unauthorized call to the protected API.
docker-compose up. After a short while, Apigee Edge authorizer should be running.
docker-compose up Creating apigee-edge-authorizer ... done Attaching to apigee-edge-authorizer apigee-edge-authorizer | time="2021-08-27T13:37:53Z" level=info msg="starting apigee authorizer" commit=289e388 version=1.13.0 apigee-edge-authorizer | time="2021-08-27T13:37:54Z" level=info msg="apigee-authorizer listening on https://localhost:8442"
Go to *Enforcement -> Authorizers > your_gateway > APIs. You should see a familiar list of services deployed using Apigee Edge.
If you do not see a list of services deployed on Apigee Edge, make sure that at least one API Product is defined in your Apigee Edge organization with a connected API proxy.
If you need to limit the count of discovered APIs, you can configure
environment_name_regexp. Setting it up will limit discovered APIs to matching names.
Select Connect > Create new service on a protected API from the list to add it to a list of ACP-protected services. Give this new ACP service a name when prompted.
If you selected the Create and bind services automatically option when creating the gateway, your services are bound already.
Your Apigee Edge-protected API is now on the list of ACP-protected services.
Deploy your Apigee Edge authorizer so that it is available publicly.
So far, you have only deployed your Apigee Edge authorizer locally using the Docker image provided by Cloudentity. You must expose it publicly as it is needed later on for the integration to work. For testing purposes, you can use tools like, for example, ngrok that expose local servers behind NATs and firewalls to public internet over secure channels.
Configure Apigee Edge Gateway
With Apigee Edge Gateway, you can define policies that are an Edge components that you can attach to different points in the message flow through your API proxies. Such policies can transform the message format, call remote services, and more. To protect your APIs, elevate the integration between ACP and the Apigee Edge platform. Doing so allows you to enforce access control using Apigee Edge policies and ACP authorization policies.
In your Apigee Edge API Proxy settings, go to the DEVELOP tab.
In the Navigator > Policies add a policy of the Flow Callout type.
You can find the Flow Callout policy type under the EXTENSTION tree node.
Provide a name and a display name for your policy.
As a shared flow, use the Authorizer shared flow.
Your policy is created. It is defined with the following XML:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?> <FlowCallout async="false" continueOnError="false" enabled="true" name="Flow-Callout"> <DisplayName>Flow Callout</DisplayName> <FaultRules/> <Properties/> <SharedFlowBundle>Authorizer</SharedFlowBundle> </FlowCallout>
Configure your policy so that it points to your Apigee Edge authorizer’s
/authorizeendpoint that you have deployed in the seventh step of the Integrate ACP and Apigee Edge section
<?xml version="1.0" encoding="UTF-8" standalone="yes"?> <FlowCallout async="false" continueOnError="false" enabled="true" name="microPerimeter"> <DisplayName>microPerimeter</DisplayName> <FaultRules/> <Properties/> <Parameters> <Parameter name="authorizer_url">https://yourAuthorizerURL/authorize</Parameter> <Parameter name="proxy_body">false</Parameter> </Parameters> <SharedFlowBundle>Authorizer</SharedFlowBundle> </FlowCallout>
proxy_bodyparameter is set to
true, the shared flow policy proxies the request body to the authorizer and then to the policies. Thanks to that it is possible to create policies that reject requests based on the request body. The request body must be in the JSON format.
proxy_bodyoption is disabled by default to make it possible to use bigger-sized request bodies, for example, for image uploads.
Add your new policy as a
<step>element to your Proxy Endpoints PreFlows.
<PreFlow name="PreFlow"> <Request> <Step> <Name>microPerimeter</Name> </Step> </Request> <Response/> </PreFlow>
You have to add your new policy to your Proxy Endpoints PreFlows, as the authorization must take place before the request reaches to target endpoint.
Apply a sample policy
In ACP, create a policy.
Select Enforcement > APIs from the left sidebar.
Select a service protected by the Apigee Edge authorizer and any API with authorization status Unrestricted.
In the popup window, select Policy from the dropdown list and click Save to proceed.
You have successfully assigned a policy to your API.
To test if your integration was successfull and that your APIs are protected, you can, for example,
create a simple Cloudentity or REGO policy that will always pass. Call your protected endpoint and
check if the response contains the successfull status. If yes, change your policy so that it blocks
APIs. The next request to your protected enpoint should end with the
unauthorized access error.
HTTP 403 status codes
Check your Apigee
Check if the configured user exists in a given Apigee organization
Check if the user has an access necessary to perform a given operation
To quickly check if Apigee Edge credentials are configured correctly, run a single API discovery pass:
docker-compose run apigee-authorizer discovery
The expected result is a log with a list of APIs required by ACP.
Apigee Edge authorizer is able to log all inbound and outbound traffic from the Apigee Edge
API. These logs can be useful to debug connectivity problems. To enable it, the
debug flag must be
true. The flag can be set by using an environment variable or passed directly via
a configuration file. The
debug flag works with the
start (default) and
The debug logs contain sensitive information such as credentials.