PingAuthorize

API gateway path parameters

The inbound-base-path property value can include parameters. If parameters are found and matched, they are included in policy requests as fields of the Gateway policy request attribute.

Other configuration properties can use these parameters. Learn more in Gateway API Endpoint configuration properties.

You must use the inbound-base-path property to introduce parameters. Other configuration properties cannot introduce new parameters.

Basic example

The following example configuration demonstrates how request URIs are mapped to the outbound path to alter policy requests:

Gateway API Endpoint property Example value

inbound-base-path

/accounts/{accountId}/transactions

outbound-base-path

/api/v1/accounts/{accountId}/transactions

policy-request-attribute

foo=bar

A request URI with the path /accounts/XYZ/transactions/1234 matches the inbound base path and is mapped to the outbound path /api/v1/accounts/XYZ/transactions/1234.

The following properties are added to the policy request:

  • HttpRequest.ResourcePath : 1234

  • Gateway.accountId : XYZ

  • Gateway.foo : bar

Advanced example

Unlike the basic example, which extracted a single path parameter, this example demonstrates how multiple parameters can be extracted from the request URI and referenced in other configuration properties.

Consider the following example configuration:

Gateway API Endpoint property Example value

inbound-base-path

/health/{tenant}/{resourceType}

outbound-base-path

/api/v1/health/{tenant}/{resourceType}

service

HealthAPI.{resourceType}

resource-path

{resourceType}/{_TrailingPath}

A request URI with the path /health/OmniCorp/patients/1234 matches the inbound base path and is mapped to the outbound path /api/v1/health/OmniCorp/patients/1234.

The following properties are added to the policy request:

  • service : HealthAPI.patients

  • HttpRequest.ResourcePath : patients/1234

  • Gateway.tenant : OmniCorp

  • Gateway.resourceType : patients