PingAuthorize Server Documentation Index
Configuration Reference Home

Policy Configuration Key

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 Configuration Keys are key-value pairs that are used to pass arbitrary, environment-specific values to the policy trust framework.

A Policy Configuration Key defines a named value that the PingAuthorize Server provides to the trust framework when using embedded PDP mode.

Policy Configuration Keys can be used to provide sensitive or environment-specific values such as server hostnames and credentials to the policy trust framework, preventing the need to hard-code those values in trust framework attributes. They are analogous in function to configuration keys used by the Policy Administration GUI in external PDP mode.

Policy Configuration Key values are stored in encrypted form in the server configuration but are decrypted to plaintext when viewed in dsconfig or the Administrative Console.

↓Relations to This Component
↓Properties
↓dsconfig Usage

Relations to This Component

The following components have a direct composition relation to Policy Configuration Keys:

Properties

The properties supported by this managed object are as follows:


Basic Properties: Advanced Properties:
↓ description  None
↓ policy-configuration-value

Basic Properties

description

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

policy-configuration-value

Description
Policy Configuration value
Default Value
None
Allowed Values
A string
Multi-Valued
No
Required
Yes
Admin Action Required
None. Modification requires no further action


dsconfig Usage

To list the configured Policy Configuration Keys:

dsconfig list-policy-configuration-keys
     [--property {propertyName}] ...

To view the configuration for an existing Policy Configuration Key:

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

To update the configuration for an existing Policy Configuration Key:

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

To create a new Policy Configuration Key:

dsconfig create-policy-configuration-key
     --key-name {name}
     --set policy-configuration-value:{propertyValue}
     [--set {propertyName}:{propertyValue}] ...

To delete an existing Policy Configuration Key:

dsconfig delete-policy-configuration-key
     --key-name {name}