Encryption key object fields

MiaRec can encrypt audio files with a per-tenant RSA key pair. The public key encrypts the files. The private key, protected by the credentials of the users authorized to use it, decrypts them for playback. See Encryption.

Example of an encryption key object:

{
    "encrypt_key": {
        "key_id": "e9780258-f061-11e5-b9d7-e03f497dbdff",
        "tenant_id": "11111111-1111-1111-1111-111111111111",
        "name": "Acme 2026",
        "fingerprint": "cb874f07fe39656cf88150e569b5b9e8",
        "protection_mode": "user",
        "is_active": true,
        "public_key": "MIGfMA0GCSqGSIb3DQEBAQUAA4GNA..."
    }
}

Attribute	Type	Description
key_id	UUID	Unique ID of the key, assigned by MiaRec when the key is created. Read-only.
tenant_id	UUID	ID of the tenant the key belongs to. Ignored when multi-tenancy is disabled. When omitted on creation, the key is created in the tenant of the API user.
name	string	Name of the key, up to 255 characters. Default "Encryption key".
fingerprint	string	Fingerprint of the public key. Read-only. The same value appears in encrypt_fingerprint of the files encrypted with this key.
protection_mode	string	How the private key is protected: user - by the credentials of each authorized user. Users must be granted access explicitly (default) app - by the application. Required when users sign in through SAML 2.0 single sign-on, or when speech analytics must access encrypted files Cannot be changed after creation.
is_active	boolean	When true, new recordings of the tenant are encrypted with this key. When false, the key is used only to decrypt recordings that were encrypted with it before. Default false.
public_key	string	RSA public key in PEM format (Base64). Read-only after creation.

The following attributes are write-only and are accepted on creation only. See Create encryption key.

Attribute	Type	Description
add_type	string	generate a new key pair (default), or import an existing one.
key_length	integer	Length of the generated key in bits: 1024, 2048 (default, recommended), or 4096.
private_key	string	RSA private key in PEM format, for import.
private_key_password	string	Password of the imported private key, if it was exported with password protection. Up to 64 characters.