---
title: Encryption Key/Salt
description: The key/salt used by the default encryption class to perform encryption and decryption within the agent.
component: java-agents
version: 2025.11
page_id: java-agents:properties-reference:org.forgerock.agents.encryption.key
canonical_url: https://docs.pingidentity.com/java-agents/2025.11/properties-reference/org.forgerock.agents.encryption.key.html
---

# Encryption Key/Salt

The key/salt used by the default encryption class to perform encryption and decryption within the agent.

Generate a secure, random key with `agentadmin --key` or `agentadmin --rotate` commands as described in [Rotate the agent profile password](../security-guide/keys.html#rotate-encryption-keys).

If this property is not set, the agent terminates with a configuration error.

|   |                                                                                                                                                                                                                                 |
| - | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|   | If you are changing this property manually or with `agentadmin --key`, you must re-encrypt the agent profile password. For more information, refer to [Encrypted Agent Password](org.forgerock.agents.encrypted.password.html). |

|                          |                                                                                                                                                                                                                                                                          |
| ------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| Property name            | `org.forgerock.agents.encryption.key`                                                                                                                                                                                                                                    |
| Aliases                  | `org.forgerock.agents.encryption.key`   Introduced in Java Agent 5.10.1   [Recognized](preface.html#how_am_manages_multiple_aliases) from AM 7.1`am.encryption.pwd`   Introduced in Java Agent 5.0`com.sun.identity.client.encryptionKey`   Introduced in Java Agent 5.0 |
| Function                 | Authentication service, Encryption                                                                                                                                                                                                                                       |
| Type                     | String                                                                                                                                                                                                                                                                   |
| Bootstrap property       | No                                                                                                                                                                                                                                                                       |
| Required property        | No                                                                                                                                                                                                                                                                       |
| Restart required         | No                                                                                                                                                                                                                                                                       |
| Local configuration file | `AgentConfig.properties`                                                                                                                                                                                                                                                 |