Submissions

Listing Encryption Keys

Changed on

This endpoint provides a listing of all known encryption keys needed to decrypt all Submissions for a given Form. It will return at least the base64RsaPublicKey property (as public) of all known versions of the form that have submissions against them. If managed keys are being used and a hint was provided, that will be returned as well.

get/v1/projects/{projectId}/forms/{xmlFormId}/submissions/keys

Request

  • Base URL
    / (relative, and the document was published on a file host, not at the API’s origin)
  • URL
    /v1/projects/{projectId}/forms/{xmlFormId}/submissions/keys
  • Auth
    none declared

Path parameters

projectIdnumber required

The numeric ID of the Project

xmlFormIdstring required

The xmlFormId of the Form being referenced.

Response

OK

idnumber required

The numerical ID of the Key.

publicstring required

The base64-encoded public key, with PEM envelope removed.

managedboolean

If true, this is a key generated by Project managed encryption. If not, this key is self-supplied.

hintstring

The hint, if given, related to a managed encryption key.

Example response

[
  {
    "id": 1,
    "public": "bcFeKDF3Sg8W91Uf5uxaIlM2uK0cUN9tBSGoASbC4LeIPqx65+6zmjbgUnIyiLzIjrx4CAaf9Y9LG7TAu6wKPqfbH6ZAkJTFSfjLNovbKhpOQcmO5VZGGay6yvXrX1TFW6C6RLITy74erxfUAStdtpP4nraCYqQYqn5zD4/1OmgweJt5vzGXW2ch7lrROEQhXB9lK+bjEeWx8TFW/+6ha/oRLnl6a2RBRL6mhwy3PoByNTKndB2MP4TygCJ/Ini4ivk74iSqVnoeuNJR/xUcU+kaIpZEIjxpAS2VECJU9fZvS5Gt84e5wl/t7bUKu+dlh/cUgHfk6+6bwzqGQYOe5A==",
    "managed": true,
    "hint": "it was a secret"
  }
]

Changes