The policy verifies the access token from the bundled Apigee OAuth server and extracts details like username and client ID and other request metadata. It can verify access tokens provided as part of a request header or a query parameter.

The OAuthPolicy extracts request metadata tagged to an access token. The policy should be executed before the PingIntelligence policy that builds the ASE request message, which captures the username and client ID from the metadata extracted by OAuthPolicy.

The OAuthPolicy can be attached using a flow hook or a flow callout. For more information, see Deploying the PingIntelligence policy for flow hook and Deploying the PingIntelligence policy for Flow Callout.

You should deploy the OAuthPolicy.xml using a Flow CallOut policy to leverage the flexibility of applying on a per API basis. For more information, see Configuring PingIntelligence Flow Callout in Apigee.

The following screen capture illustrates the PingIntelligence shared flow with OAuthPolicy.

Screenshot of PingIntelligence shared flow with OAuthPolicy

At present, the OAuthPolicy supports extraction of user information from access tokens generated by Apigee bundled OAuth server only.

Configure file to capture the user information

Additionally set the configuration properties in file to extract the user information using the PingIntelligence OAuthPolicy. For more information, see Configure file to extract user information.


If a custom OAuth policy is used in place of PingIntelligence OAuthPolicy, then configure the enable_oauth_policy variable in to false.