---
title: SecretKeyPropertyFormat
description: The format of a secret used with a secret store.
component: pinggateway
version: 2026
page_id: pinggateway:reference:SecretKeyPropertyFormat
canonical_url: https://docs.pingidentity.com/pinggateway/2026/reference/SecretKeyPropertyFormat.html
revdate: 2025-06-02T18:01:47Z
section_ids:
  SecretKeyPropertyFormat-usage: Usage
  SecretKeyPropertyFormat-properties: Properties
  SecretKeyPropertyFormat-example: Example
  SecretKeyPropertyFormat-moreinfo: More information
---

# SecretKeyPropertyFormat

The format of a secret used with a secret store.

## Usage

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

## Properties

* `format`: *SecretPropertyFormat [reference](preface.html#definition-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](preface.html#definition-string)>, required*

  The algorithm name used for encryption and decryption. Use algorithm names given in [Java Security Standard Algorithm Names](https://docs.oracle.com/en/java/javase/11/docs/specs/security/standard-names.html#algorithmparameters-algorithms).

## Example

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

## More information

[Secrets](secrets.html)

[org.forgerock.openig.secrets.SecretKeyPropertyFormatHeaplet](../_attachments/apidocs/org/forgerock/openig/secrets/SecretKeyPropertyFormatHeaplet.html)