PingAuthorize Server Documentation Index
Configuration Reference Home

JSON PDP API HTTP Servlet Extension

The JSON PDP API HTTP Servlet Extension enables the PingAuthorize Server server to act as an external Policy Decision Point for other applications acting as Policy Enforcement Points.

The JSON PDP API HTTP Servlet Extension provides a simple JSON REST API which maps directly to entities used by the trust framework and policies defined in the Policy Editor, enabling other applications to act as Policy Enforcement Points using the PingAuthorize Server as an external Policy Decision Point.

Parent Component
Relations from This Component
Properties
dsconfig Usage

Parent Component

The JSON PDP API HTTP Servlet Extension component inherits from the HTTP Servlet Extension

Relations from This Component

The following components have a direct aggregation relation from JSON PDP API HTTP Servlet Extensions:

Properties

The properties supported by this managed object are as follows:


Basic Properties: Advanced Properties:
↓ description  None
↓ cross-origin-policy
↓ response-header
↓ correlation-id-response-header
↓ shared-secret-header-name
↓ shared-secrets

Basic Properties

description

Description
A description for this HTTP Servlet Extension
Default Value
None
Allowed Values
A string
Multi-Valued
No
Required
No
Admin Action Required
None. Modification requires no further action

cross-origin-policy

Description
The cross-origin request policy to use for the HTTP Servlet Extension. A cross-origin policy is a group of attributes defining the level of cross-origin request supported by the HTTP Servlet Extension.
Default Value
No cross-origin policy is defined and no CORS headers are recognized or returned.
Allowed Values
The DN of any HTTP Servlet Cross Origin Policy.
Multi-Valued
No
Required
No
Admin Action Required
None. Modification requires no further action

response-header

Description
Specifies HTTP header fields and values added to response headers for all requests. Values specified here must specify both the header field name and the value in conformance with RFC 2616. Fields may only be specified once; multiple values for the same header should be comma-separated. See RFC 7231 for a standard set of field names.
Any response headers configured for this HTTP Servlet Extension will be combined with response headers configured on the corresponding Connection Handler. In the case of duplicates, the headers configured on this HTTP Servlet Extension will be used instead of the headers configured on the Connection Handler.
Default Value
None
Allowed Values
Colon-separated header field name and value
Multi-Valued
Yes
Required
No
Admin Action Required
HTTP Connection Handlers hosting this HTTP Servlet Extension must be disabled and then re-enabled, or the server restarted, in order for this change to take effect.

correlation-id-response-header

Description
Specifies the name of the HTTP response header that will contain a correlation ID value. Example values are "Correlation-Id", "X-Amzn-Trace-Id", and "X-Request-Id". This property can be used to specify a custom response header name for correlation IDs. The value specified here will override the correlation-id-response-header property of the HTTP Connection Handler hosting this HTTP Servlet Extension.

If the use-correlation-id-header property of the HTTP Connection Handler hosting this HTTP Servlet Extension is not enabled, then this property will be ignored.

Default Value
The correlation-id-response-header property of the HTTP Connection Handler hosting this HTTP Servlet Extension will be used.
Allowed Values
A string
Multi-Valued
No
Required
No
Admin Action Required
None. Modification requires no further action

shared-secret-header-name

Description
The request header used to find the shared secret header for incoming JSON PDP API HTTP Servlet Extension requests. The JSON PDP API HTTP Servlet Extension will use this header name when inspecting incoming HTTP requests for the shared secret value(s).
Default Value
CLIENT-TOKEN
Allowed Values
RFC 2616-conformant HTTP header field name
Multi-Valued
No
Required
Yes
Admin Action Required
None. Modification requires no further action

shared-secrets

Description
Shared secrets between the third-party Policy Enforcement Point and the JSON PDP API HTTP Servlet Extension. A request will be considered authenticated by the JSON PDP API HTTP Servlet Extension if the incoming shared secret matches any active shared secrets in this list.
Default Value
The JSON PDP API HTTP Servlet Extension will treat all requests as authenticated regardless of the incoming shared secret, even if there is none.
Allowed Values
The DN of any Authorization Policy Decision Shared Secret.
Multi-Valued
Yes
Required
No
Admin Action Required
None. Modification requires no further action


dsconfig Usage

To list the configured HTTP Servlet Extensions:

dsconfig list-http-servlet-extensions
     [--property {propertyName}] ...

To view the configuration for an existing HTTP Servlet Extension:

dsconfig get-http-servlet-extension-prop
     --extension-name {name}
     [--tab-delimited]
     [--script-friendly]
     [--property {propertyName}] ...

To update the configuration for an existing HTTP Servlet Extension:

dsconfig set-http-servlet-extension-prop
     --extension-name {name}
     (--set|--add|--remove) {propertyName}:{propertyValue}
     [(--set|--add|--remove) {propertyName}:{propertyValue}] ...