Skip to content

Encrypt sensitive fields

How-to6 minExpert

Before you start

Encrypting a field protects its values at rest, for example a national ID or a bank account. You add a key once, then choose it on each field that needs protection.

  1. Open Account settings › Users & Security and choose Encryption Keys.
  2. Click Add New Key.
  3. Type a Key Alias that says what the key is for, for example Primary Database Key. Each alias is used once.
  4. Describe the key in Description if you wish.
  5. Paste your key into Encryption Key. Use a Base64, PEM or hex key of at least 32 characters.
  6. Click Save Encryption Keys.

Beezr shows “Encryption key ‘Primary Database Key’ has been created successfully.” The key is stored encrypted in the vault, and its tag reads ACTIVE.

The Encryption Keys page with the Add New Key button, the Key Management Best Practices note and the list of keys with their ACTIVE tag.
    Add New Key opens the dialog.
    Read Key Management Best Practices before you start.
    Each row shows the alias, description and creation date.
  1. Open the module’s Fields page and click Add field.
  2. Fill in the label and type.
  3. Under Storage, switch on Encrypt values.
  4. Pick the Encryption key.
  5. Click Save field.

The panel shows Encryption active. Choose the encryption when you create the field, and use it for values people read on the record, such as an ID number.

Click Delete on a key. If fields use it, Beezr lists them and asks you to remove the key from those fields first.

Keep the key active for as long as a field uses it. The field relies on it to read its values.

Check yourself

What must exist before you can turn on Encrypt values for a field?
Show the answer

An encryption key under Encryption Keys. The field asks you to choose an encryption key, so one must exist.

A key is used by a field. What happens when you try to delete the key?
Show the answer

Beezr lists the fields that use it and asks you to remove it from them first. The dependency check lists where the key is used.

What's next

Last checked