PingAuthorize

Sideband API path parameters

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

Other configuration properties can use these parameters. For more information, see Sideband API Endpoint configuration properties.

The base-path property must introduce parameters. Other configuration properties cannot introduce new parameters.

Basic example

The following table demonstrates a basic configuration of path parameters.

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

The following table demonstrates an advanced configuration of path parameters.

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