Gateway API Endpoint property Description
inbound-base-path Defines the URI path prefix that the gateway uses to determine whether the Gateway API Endpoint handles a request.

The inbound-base-path property value can include parameters. If parameters are found and matched, they are included as attributes to policy requests.

The following configuration properties reference parameters that the inbound-base-path introduces:

  • outbound-base-path
  • service
  • resource-path
  • policy-request-attribute
service Identifies the API service to the PDP.

The service value appears in the policy request as the service attribute.

If undefined, the service value defaults to the name of the Gateway API Endpoint.

resource-path Identifies the REST resource to the PDP.

The resource path value appears in the policy request as the HttpRequest.ResourcePath attribute.

If undefined, the resource path value defaults to the portion of the request that follows the base path defined by inbound-base-path.

policy-request-attribute Defines zero or more static, arbitrary key-value pairs. If specified, key-value pairs are always added as attributes to policy requests.

These custom attributes appear in the policy request as fields of the Gateway attribute. For example, if a value of policy-request-attribute is foo=bar, the attribute is added to the policy request with a value of bar.