Protecting an API with PingAccess in an agent deployment - PingAccess - 7.3

Prerequisites

Before configuring your PingAccess deployment to protect an API:

• PingAccess must be installed and running. See Installing and Uninstalling PingAccess for the full procedure.
• You must have a configured token provider. The procedures vary depending on the token provider. For more information, see:
  • PingFederate.
  • PingOne.
  • Common token provider.
• You must have installed an agent on the web server or servers that host the API you want to protect. For more information, see:
  • PingAccessAgent for Apache (RHEL)
  • PingAccessAgent for Apache (SLES)
  • PingAccessAgent for Apache (Windows)
  • PingAccessAgent for IIS
  • PingAccessAgent for NGINX

Steps

After you have completed the following steps, your API is protected.

1. Configure a virtual host – A virtual host represents the API you will protect and contains information about its location.
2. Configure a rule – Rules control who can access what content under what circumstances.
3. Configure an identity mapping – An identity mapping lets you share identity information with the protected API as headers.
4. Configure an application – An application joins the other pieces together, giving users access to the API according to the configured rules.
5. Configure a resource – A resource specifies an API endpoint and the methods that can be used to access it.