PingAuthorize Server Documentation Index
Configuration Reference Home

Modify Headers Advice

Note: this component stores cluster-wide configuration data and is mirrored across all servers in the topology within the the same cluster.

Note: changes to cluster-wide configuration objects are immediately and automatically mirrored across all servers within the same cluster, so offline changes are not supported.

Policy advice that specifies changes that must be made to the headers of a request before it is forwarded to the upstream server, or the headers of a response before it is returned to the requesting client.

The payload for this advice is a JSON object. The keys are the names of the headers to set, and the values are the new values of the headers. A value may be null, which will remove the header; a string, which will set the header to that value; or an array of strings, which will set the header to all of those values. If the header already exists, it will be overwritten; if it does not exist, it will be added (unless the value is null). If a payload value is an array of strings and the header supports multiple values, such as Accept, PingAuthorize Server repeats the header for each string in the array. If a payload value is an array of strings and the header does not support multiple values, such as Content-Type, PingAuthorize Server sends the last string in the array.

Parent Component
Properties
dsconfig Usage

Parent Component

The Modify Headers Advice component inherits from the Advice

Properties

The properties supported by this managed object are as follows:


Basic Properties: Advanced Properties:
↓ advice-id  None
↓ decision-type
↓ evaluation-order-index

Basic Properties

advice-id (Read-Only)

Description
A unique identifier for the advice type. This ID must match the "code" string returned from a policy decision request.
Default Value
modify-headers
Allowed Values
A string
Multi-Valued
No
Required
Yes
Admin Action Required
None. Modification requires no further action

decision-type (Read-Only)

Description
A value indicating to what type of decisions this advice should be applied.
Default Value
PERMIT
DENY
Allowed Values
PERMIT - Only applied to PERMIT decisions.

DENY - Only applied to DENY decisions.
Multi-Valued
Yes
Required
No
Admin Action Required
None. Modification requires no further action

evaluation-order-index (Read-Only)

Description
If multiple Advice are returned from a single policy request, then this property governs the order in which the Advice will be processed by the Policy Enforcement Point. Obligatory Advice are processed first. Within the set of obligatory or non-obligatory Advice, those with a smaller evaluation-order-index will be evaluated first. If multiple Advice have the same evaluation-order-index, then their order of evaluation is indeterminate.
Default Value
10
Allowed Values
An integer value. Lower limit is 0.
Multi-Valued
No
Required
No
Admin Action Required
None. Modification requires no further action


dsconfig Usage

To list the configured Advice:

dsconfig list-advice
     [--property {propertyName}] ...

To view the configuration for an existing Advice:

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

To update the configuration for an existing Advice:

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