PingAuthorize Server Documentation Index
Configuration Reference Home

Secret Key

Note: this component is designated "advanced", which means that objects of this type are not expected to be created or altered in most environments. If you believe that such a change is necessary, you may want to contact support in order to understand the potential impact of that change.

Note: this is an abstract component that cannot be instantiated.

The Secret Key represents a secret key used by the server for encryption/decryption purposes and generating/verifying digital signatures.

Direct Subcomponents
Properties

Direct Subcomponents

The following Secret Keys are available in the server :

These Secret Keys inherit from the properties described below.

Properties

The properties supported by this managed object are as follows:


Basic Properties: Advanced Properties:
↓ key-id ↓ key-length-bits
↓ is-compromised

Basic Properties

key-id (Read-Only)

Description
The unique system-generated identifier for the Secret Key.
Default Value
None
Allowed Values
A string
Multi-Valued
No
Required
Yes
Admin Action Required
None. Modification requires no further action

is-compromised

Description
If the key is compromised, an administrator may set this flag to immediately trigger the creation of a new secret key. After the new key is generated, the value of this property will be reset to false.
Default Value
None
Allowed Values
true
false
Multi-Valued
No
Required
No
Admin Action Required
None. If set to true, a new secret key is immediately generated, and all the servers in the topology are immediately notified of the change. All cryptographic operations performed after the change should still function normally. So no further administrative action is required.


Advanced Properties

key-length-bits (Advanced Property, Read-Only)

Description
The length of the key in bits.
Default Value
128
Allowed Values
An integer value. Lower limit is 0.
Multi-Valued
No
Required
Yes
Admin Action Required
None. Modification requires no further action