PingAuthorize

Sideband API path parameters

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

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

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

Basic example

The following example configuration demonstrates how request URIs alter policy requests:

Sideband API Endpoint property Example value

base-path

/accounts/{accountId}/transactions

policy-request-attribute

foo=bar

A request URI with the path /accounts/XYZ/transactions/1234 matches the example base-path value.

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:

Sideband API Endpoint property Example value

base-path

/health/{tenant}/{resourceType}

service

HealthAPI.{resourceType}

resource-path

{resourceType}/{_TrailingPath}

A request URI with the path /health/OmniCorp/patients/1234 matches the example base-path value.

The following properties are added to the policy request:

  • service : HealthAPI.patients

  • HttpRequest.ResourcePath : patients/1234

  • Gateway.tenant : OmniCorp

  • Gateway.resourceType : patients