From b5047fd8c851bb02b7cab91042f8fe739c7fb8b8 Mon Sep 17 00:00:00 2001 From: Scott Miller Date: Thu, 13 Oct 2022 16:31:07 -0500 Subject: [PATCH] Document the deletion_allowed transform flag (#17544) * Document the deletion_allowed transform flag * Remove duplicated sentence --- website/content/api-docs/secret/transform.mdx | 15 ++++++++++++++- 1 file changed, 14 insertions(+), 1 deletion(-) diff --git a/website/content/api-docs/secret/transform.mdx b/website/content/api-docs/secret/transform.mdx index db91033560..390b609778 100644 --- a/website/content/api-docs/secret/transform.mdx +++ b/website/content/api-docs/secret/transform.mdx @@ -181,7 +181,9 @@ configuration endpoints, and will be removed in a future release. A role using this transformation must exist in this list in order for encode and decode operations to properly function. -- +- `deletion_allowed` `(bool: false)` - + If true, this transform can be deleted. Otherwise deletion is blocked while + this value remains false. ### Sample Payload @@ -233,6 +235,12 @@ transformation exists, it will be updated with the new attributes. A role using this transformation must exist in this list in order for encode and decode operations to properly function. +- `deletion_allowed` `(bool: false)` - + If true, this transform can be deleted. Otherwise deletion is blocked while this + value remains false. Note that deleting the transform deletes the underlying + key making decoding of FPE encoded values impossible without restoring from a + backup. + ### Sample Payload ```json @@ -337,6 +345,11 @@ transformation exists, it will be updated with the new attributes. The list of tokenization stores to use for tokenization state. Vault's internal storage is used by default. +- `deletion_allowed` `(bool: false)` - + If true, this transform can be deleted. Otherwise deletion is blocked while this + value remains false. Note that deleting the transform deletes the underlying key + making decoding of tokenized values impossible without restoring from a backup. + ### Sample Payload ```json