PingGateway 2025.3

SecretKeyPropertyFormat

The format of a secret used with a secret store.

Usage

{
  "name": string,
  "type": "SecretKeyPropertyFormat",
  "config": {
    "format": SecretPropertyFormat reference,
    "algorithm": configuration expression<string>
  }
}
json

Properties

format: SecretPropertyFormat reference, optional

Format in which the secret is stored. Use one of the following values or define a format:

  • BASE64: Base64-encoded

    The original secret prior to base64-encoding must use UTF-8 encoding.

  • PLAIN: Plain text

    The text must use UTF-8 encoding.

Default: BASE64

"algorithm": configuration expression<string>, required

The algorithm name used for encryption and decryption. Use algorithm names given in Java Security Standard Algorithm Names.

Example

{
  "type": "SecretKeyPropertyFormat",
  "config": {
    "format": "PLAIN",
    "algorithm": "AES"
  }
}
json

More information

Secrets

org.forgerock.openig.secrets.SecretKeyPropertyFormatHeaplet