> For the complete documentation index, see [llms.txt](https://docs.digibee.com/documentation/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.digibee.com/documentation/connectors-and-triggers/connectors/security/pgp.md). # PGP **PGP (Pretty Good Privacy)** is an encryption connector that provides authentication and privacy for data communication. ## **Parameters** Configure the connector using the parameters below. Fields that support [Double Braces expressions](/documentation/connectors-and-triggers/double-braces/overview.md) are marked in the **Supports DB** column. {% tabs %} {% tab title="General" %}

Parameter	Description	Data type	Supports DB	Default	Visible when
Use Dynamic Account	If enabled, the connector uses the account dynamically via the Store Account connector; otherwise, it uses the account statically as configured in Accounts on the Platform.	Boolean	❌	`false`	—
Scoped	If enabled, isolates the stored account from other sub-processes. Not supported for accounts used in headers or body. To learn more, read the Dynamic Accounts documentation.	Boolean	❌	`false`	Use Dynamic Account is enabled
Account Name	Name of the account defined in the Store Account connector.	String	✅	N/A	Use Dynamic Account is enabled
Account	Account to be used by the connector. Must be a Public or Private Key account type, configured in Accounts on the Platform.	String	❌	N/A	Use Dynamic Account is disabled
Operation	Defines the type of operation to be performed: Encrypt Fields, Decrypt Fields, Encrypt Payload, Decrypt Payload, Encrypt File, or Decrypt File.	String	❌	`Encrypt Fields`	—
Fields	Names of the fields to be encrypted or decrypted within the JSON entry. Multiple fields must be separated by commas (e.g., `param1, param2`).	String	❌	`parameter`	Operation is Encrypt Fields or Decrypt Fields
Payload	Content to be encrypted or decrypted. Can be defined as a single fixed value or dynamically referenced using Double Braces expression to get and set the payload.	String	✅	N/A	Operation is Encrypt Payload or Decrypt Payload
Charset	Character encoding used to interpret the text.	String	❌	`UTF-8`	—
File Name	Name or full path of the file to be encrypted or decrypted (e.g., `tmp/processed/file.txt`).	String	✅	N/A	Operation is Encrypt File or Decrypt File
Output File Name	Name to be assigned to the resulting encrypted or decrypted file.	String	✅	N/A	Operation is Encrypt File or Decrypt File
Hexadecimal	If enabled, the value to be signed or verified must be provided in hexadecimal format; otherwise, it is signed or verified in base64 format.	Boolean	❌	`true`	—
Armor	If enabled, encrypts the message using ASCII armor so it can be transmitted in standard text-based formats, such as email.	Boolean	❌	`false`	Operation is Encrypt Fields, Encrypt Payload, Encrypt File
Zip	If enabled, compresses the message before encryption.	Boolean	❌	`false`	Operation is Encrypt Fields, Encrypt Payload, Encrypt File
Integrity Check	If enabled, verifies the integrity of the message during the operation.	Boolean	❌	`true`	Operation is Encrypt Fields, Encrypt Payload, Encrypt File
Fail On Error	If enabled, interrupts pipeline execution when an error occurs. Otherwise, execution proceeds and the result returns `false` for the `"success"` property.	Boolean	❌	`false`	—

{% endtab %} {% tab title="Documentation" %} | Parameter | Description | Data type | Supports DB | Default value | | ----------------- | --------------------------------------------------------------------------------------- | --------- | ----------- | ------------- | | **Documentation** | Optional field to describe the connector configuration and any relevant business rules. | String | ❌ | N/A | {% endtab %} {% endtabs %} ## **Messages flow** ### **Operation Encrypt Fields** #### **Input** ```json { "parameter": "TEXT TO BE ENCRYPTED" } ``` #### **Output** ```json { "parameter": "AA01FF" // text encrypted } ``` ### **Operation Decrypt Fields** #### **Input** ```json { "parameter": "AA01FF" // text encrypted } ``` #### **Output** ```json { "parameter": "TEXT DECRYPTED" } ``` ### **Operation Encrypt Payload** #### **Input** ```json { "parameter": "TEXT TO BE ENCRYPTED" } ``` #### **Output** ```json { "result": "AA01FF" // text encrypted } ``` ### **Operation Decrypt Payload** #### **Input** ```json { "parameter": "AA01FF" // text encrypted } ``` #### **Output** ```json { "result": "TEXT DECRYPTED" } ``` ### **Operation Encrypt File** #### **Input** ```json { "fileName": "file.txt" } ``` #### **Output** ```json { "outputFileName": "file.txt.pgp" // file encrypted } ``` ### **Operation Decrypt File** #### **Input** ```json { "fileName": "file.txt.pgp" // file encrypted } ``` #### **Output** ```json { "outputFileName": "file.txt.dec" // file decrypted } ``` #### **Output with error** ```json { "error": "java.io.FileNotFoundException: data1.csv (No such file or directory)", "success": false } ``` * **success:** “false” when the operation fails. * **error:** information about the occurred error. --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter: ``` GET https://docs.digibee.com/documentation/connectors-and-triggers/connectors/security/pgp.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.