PingAuthorize Server Documentation Index
Configuration Reference Home

Include Attributes 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 limits the attributes that may be returned in a JSON response.

The payload for this advice is one or more JSONPaths; either a single path, or a JSON Array of JSON Strings containing the paths. Each path represents the attributes of the response body which are to be returned to the requester; attributes which are not specified are removed. If an attribute is selected, this also implies that all its ancestors are selected. A single JSONPath may represent multiple attributes; all of them will be included. If multiple instances of Include Attributes Advice are returned from policy, they are combined such that the union of all attributes selected will be included in the response. This advice cannot be used on a SCIM "modify" request.

↓Parent Component
↓Properties
↓dsconfig Usage

Parent Component

The Include Attributes 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
include-attributes
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
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 Include Attributes Advice are returned from a single policy request, then this property governs the order in which the Include Attributes Advice will be processed by the Policy Enforcement Point. Obligatory Include Attributes Advice are processed first. Within the set of obligatory or non-obligatory Include Attributes Advice, those with a smaller evaluation-order-index will be evaluated first. If multiple Include Attributes Advice have the same evaluation-order-index, then their order of evaluation is indeterminate.
Default Value
20
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}] ...