> 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/pt-br/connectors/security/pgp.md).

# PGP

**PGP (Pretty Good Privacy)** é um conector de criptografia que oferece autenticação e privacidade para comunicação de dados.

## **Parâmetros**

Configure o conector utilizando os parâmetros abaixo. Os campos que suportam [expressões Double Braces](/documentation/connectors-and-triggers/pt-br/double-braces/overview.md) estão marcados na coluna **Suporta DB**.

{% tabs %}
{% tab title="General" %}

<table data-header-hidden="false" data-header-sticky><thead><tr><th width="112">Parâmetro</th><th width="231">Descrição</th><th width="83">Tipo de dado</th><th width="81">Suporta DB</th><th width="100">Valor padrão</th><th width="129">Visível quando</th></tr></thead><tbody><tr><td><strong>Use Dynamic Account</strong></td><td>Se habilitado, o conector usa a conta de forma dinâmica via o conector <a href="/pages/iulYYuz29bvfGjceZb4e"><strong>Store Account</strong></a>; caso contrário, usa a conta estática configurada em <a href="/spaces/cO0A6g1dOsu8BiHYqO67/pages/fS1QLzAg8rGSSJFwtrvy"><strong>Contas</strong></a> na Plataforma.</td><td>Boolean</td><td>❌</td><td><code>false</code></td><td>—</td></tr><tr><td><strong>Scoped</strong></td><td>Se habilitado, isola a conta armazenada de outros subprocessos. Não é suportado para contas usadas em headers ou body. Para saber mais, consulte a <a href="/spaces/cO0A6g1dOsu8BiHYqO67/pages/FrKJOmsImCRBImMPMsU2">documentação de Dynamic Accounts</a>.</td><td>Boolean</td><td>❌</td><td><code>false</code></td><td><strong>Use Dynamic Account</strong> está habilitado</td></tr><tr><td><strong>Account Name</strong></td><td>Nome da conta definida no conector <a href="/pages/iulYYuz29bvfGjceZb4e"><strong>Store Account</strong></a>.</td><td>String</td><td>✅</td><td>N/A</td><td><strong>Use Dynamic Account</strong> está habilitado</td></tr><tr><td><strong>Account</strong></td><td>Conta a ser usada pelo conector. Deve ser do tipo de conta <strong>Public Key</strong> ou <strong>Private Key</strong>, configurada em <a href="/spaces/cO0A6g1dOsu8BiHYqO67/pages/fS1QLzAg8rGSSJFwtrvy"><strong>Contas</strong></a> na Plataforma.</td><td>String</td><td>❌</td><td>N/A</td><td><strong>Use Dynamic Account</strong> está desabilitado</td></tr><tr><td><strong>Operation</strong></td><td>Define o tipo de operação a ser executada: <strong>Encrypt Fields</strong>, <strong>Decrypt Fields</strong>, <strong>Encrypt Payload</strong>, <strong>Decrypt Payload</strong>, <strong>Encrypt File</strong> ou <strong>Decrypt File</strong>.</td><td>String</td><td>❌</td><td><code>Encrypt Fields</code></td><td>—</td></tr><tr><td><strong>Fields</strong></td><td>Nomes dos campos a serem criptografados ou descriptografados dentro da entrada JSON. Múltiplos campos devem ser separados por vírgula (ex.: <code>param1, param2</code>).</td><td>String</td><td>❌</td><td><code>parameter</code></td><td><strong>Operation</strong> é <strong>Encrypt Fields</strong> ou <strong>Decrypt Fields</strong></td></tr><tr><td><strong>Payload</strong></td><td>Conteúdo a ser criptografado ou descriptografado. Pode ser definido como um valor fixo único ou referenciado dinamicamente usando uma <a href="/pages/x1P78T1Kq7aPbla90qA6">expressão Double Braces</a> para obter e definir o payload.</td><td>String</td><td>✅</td><td>N/A</td><td><strong>Operation</strong> é <strong>Encrypt Payload</strong> ou <strong>Decrypt Payload</strong></td></tr><tr><td><strong>Charset</strong></td><td>Codificação de caracteres usada para interpretar o texto.</td><td>String</td><td>❌</td><td><code>UTF-8</code></td><td>—</td></tr><tr><td><strong>File Name</strong></td><td>Nome ou caminho completo do arquivo a ser criptografado ou descriptografado (ex.: <code>tmp/processed/file.txt</code>).</td><td>String</td><td>✅</td><td>N/A</td><td><strong>Operation</strong> é <strong>Encrypt File</strong> ou <strong>Decrypt File</strong></td></tr><tr><td><strong>Output File Name</strong></td><td>Nome a ser atribuído ao arquivo resultante, já criptografado ou descriptografado.</td><td>String</td><td>✅</td><td>N/A</td><td><strong>Operation</strong> é <strong>Encrypt File</strong> ou <strong>Decrypt File</strong></td></tr><tr><td><strong>Hexadecimal</strong></td><td>Se habilitado, o valor a ser assinado ou verificado deve ser informado em formato hexadecimal; caso contrário, é assinado ou verificado em formato base64.</td><td>Boolean</td><td>❌</td><td><code>true</code></td><td>—</td></tr><tr><td><strong>Armor</strong></td><td>Se habilitado, criptografa a mensagem usando ASCII armor, permitindo que seja transmitida em formatos de texto padrão, como e-mail.</td><td>Boolean</td><td>❌</td><td><code>false</code></td><td><strong>Operation</strong> é <strong>Encrypt Fields</strong>, <strong>Encrypt Payload</strong>, <strong>Encrypt File</strong></td></tr><tr><td><strong>Zip</strong></td><td>Se habilitado, compacta a mensagem antes da criptografia.</td><td>Boolean</td><td>❌</td><td><code>false</code></td><td><strong>Operation</strong> é <strong>Encrypt Fields</strong>, <strong>Encrypt Payload</strong>, <strong>Encrypt File</strong></td></tr><tr><td><strong>Integrity Check</strong></td><td>Se habilitado, verifica a integridade da mensagem durante a operação.</td><td>Boolean</td><td>❌</td><td><code>true</code></td><td><strong>Operation</strong> é <strong>Encrypt Fields</strong>, <strong>Encrypt Payload</strong>, <strong>Encrypt File</strong></td></tr><tr><td><strong>Fail On Error</strong></td><td>Se habilitado, interrompe a execução do pipeline quando ocorre um erro. Caso contrário, a execução prossegue e o resultado retorna <code>false</code> para a propriedade <code>"success"</code>.</td><td>Boolean</td><td>❌</td><td><code>false</code></td><td>—</td></tr></tbody></table>

{% endtab %}

{% tab title="Documentation" %}

| Parâmetro         | Descrição                                                                                          | Tipo de dado | Suporta DB | Valor padrão |
| ----------------- | -------------------------------------------------------------------------------------------------- | ------------ | ---------- | ------------ |
| **Documentation** | Campo opcional para descrever a configuração do conector e quaisquer regras de negócio relevantes. | String       | ❌          | N/A          |
| {% endtab %}      |                                                                                                    |              |            |              |
| {% endtabs %}     |                                                                                                    |              |            |              |

## **Fluxo de mensagens**

### **Operation Encrypt Fields**

#### **Entrada**

```json
{  
    "parameter": "TEXT TO BE ENCRYPTED"
}
```

#### **Saída**

```json
{  
    "parameter": "AA01FF" // text encrypted
}
```

### **Operation Decrypt Fields**

#### **Entrada**

```json
{  
    "parameter": "AA01FF" // text encrypted
}
```

#### **Saída**

```json
{  
    "parameter": "TEXT DECRYPTED"
}
```

### **Operation Encrypt Payload**

#### **Entrada**

```json
{  
    "parameter": "TEXT TO BE ENCRYPTED"
}
```

#### **Saída**

```json
{  
    "result": "AA01FF" // text encrypted
}
```

### **Operation Decrypt Payload**

#### **Entrada**

```json
{  
    "parameter": "AA01FF" // text encrypted
}
```

#### **Saída**

```json
{  
    "result": "TEXT DECRYPTED"
}
```

### **Operation Encrypt File**

#### **Entrada**

```json
{  
    "fileName": "file.txt"
}
```

#### **Saída**

```json
{  
    "outputFileName": "file.txt.pgp" // file encrypted
}
```

### **Operation Decrypt File**

#### **Entrada**

```json
{  
    "fileName": "file.txt.pgp" // file encrypted
}
```

#### **Saída**

```json
{  
    "outputFileName": "file.txt.dec" // file decrypted
}
```

#### **Saída com erro**

```json
{   
    "error": "java.io.FileNotFoundException: data1.csv (No such file or directory)",  
    "success": false
}
```

* **success:** "false" quando a operação falha.
* **error:** informações sobre o erro ocorrido.


---

# 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/pt-br/connectors/security/pgp.md?ask=<question>&goal=<endgoal>
```

`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.
