From 72426f81aa4329c239a28e4da491d4af04ac27b0 Mon Sep 17 00:00:00 2001 From: Victor Rodriguez Date: Fri, 8 Oct 2021 11:18:56 -0400 Subject: [PATCH] FIXUP: PR fixes #2: examples for encode/decode formats, etc. --- website/content/api-docs/secret/transform.mdx | 28 ++++++++++--------- .../content/docs/secrets/transform/index.mdx | 3 +- 2 files changed, 17 insertions(+), 14 deletions(-) diff --git a/website/content/api-docs/secret/transform.mdx b/website/content/api-docs/secret/transform.mdx index 53ff80ec5bb1..7be698cc92e8 100644 --- a/website/content/api-docs/secret/transform.mdx +++ b/website/content/api-docs/secret/transform.mdx @@ -188,7 +188,7 @@ configuration endpoints, and will be removed in a future release. ```json { "type": "fpe", - "template": "example-template", + "template": "builtin/creditcardnumber", "tweak_source": "internal", "allowed_roles": ["example-role"] } @@ -237,7 +237,7 @@ transformation exists, it will be updated with the new attributes. ```json { - "template": "example-template", + "template": "builtin/creditcardnumber", "tweak_source": "internal", "allowed_roles": ["example-role"] } @@ -381,7 +381,7 @@ $ curl \ { "data": { "allowed_roles": ["example-role"], - "templates": ["example-template"], + "templates": "[builtin/creditcardnumber]", "tweak_source": "internal", "type": "fpe" } @@ -455,8 +455,8 @@ template exists, it will be updated with the new attributes. request URL. - `type` `(string: )` - - Specifies the type of pattern matching to perform. The ony type currently supported - by this backend is `regex`. + Specifies the type of pattern matching to perform. The only type currently + supported by this backend is `regex`. - `pattern` `(string: )` - Specifies the pattern used to match a particular value. For regex type @@ -469,12 +469,14 @@ template exists, it will be updated with the new attributes. encoding and decoding operations. - `encode_format` `(string)` - - The regular expression template to use to format encoded values. This is only - used during FPE transformations. + The regular expression template to use to format encoded values. For example, + this can be used to normalize the encoded output. This is only used during FPE + transformations. - `decode_formats` `(key-value-map: {})` - An optional map of regular expression templates that can be used to customize - decoded output. This is only used during FPE transformations. + decoded output. For example, this can be used to decode only the last four + digits of a credit card number. This is only used during FPE transformations. ### Sample Payload @@ -953,7 +955,7 @@ This endpoint encodes the provided value using a named role. 7-byte value that is then base64 encoded. - `reference` `(string: "")` - - Only valid on batch requests using 'batch_input' below. A user supplied + Only valid on batch requests using 'batch_input' below. A user-supplied string that will be present on the corresponding item in the batch response, to assist in correlating inputs with outputs. @@ -1094,7 +1096,7 @@ This endpoint decodes the provided value using a named role. source. The tweak must be a 7-byte value that is then base64 encoded. - `reference` `(string: "")` - - Only valid on batch requests using 'batch_input' below. A user supplied + Only valid on batch requests using 'batch_input' below. A user-supplied string that will be present on the corresponding item in the batch response, to assist in correlating inputs with outputs. @@ -1242,7 +1244,7 @@ Only valid for tokenization transformations. must be specified. - `reference` `(string: "")` - - Only valid on batch requests using 'batch_input' below. A user supplied + Only valid on batch requests using 'batch_input' below. A user-supplied string that will be present on the corresponding item in the batch response, to assist in correlating inputs with outputs. @@ -1317,7 +1319,7 @@ transformations. must be specified. - `reference` `(string: "")` - - Only valid on batch requests using 'batch_input' below. A user supplied + Only valid on batch requests using 'batch_input' below. A user-supplied string that will be present on the corresponding item in the batch response, to assist in correlating inputs with outputs. @@ -1391,7 +1393,7 @@ Only valid for tokenization transformations. must be specified. - `reference` `(string: "")` - - Only valid on batch requests using 'batch_input' below. A user supplied + Only valid on batch requests using 'batch_input' below. A user-supplied string that will be present on the corresponding item in the batch response, to assist in correlating inputs with outputs. diff --git a/website/content/docs/secrets/transform/index.mdx b/website/content/docs/secrets/transform/index.mdx index 6c7aa6386e9a..32fe38540c7e 100644 --- a/website/content/docs/secrets/transform/index.mdx +++ b/website/content/docs/secrets/transform/index.mdx @@ -120,7 +120,8 @@ values. A transformation must be provided if the role contains more than one transformation. A tweak must be provided if the tweak source for the transformation is "supplied" or "generated". A decode format can optionally - be provided. + be provided, if none is provided, the decoded output will be formatted to + match the template's pattern as in the previous example. ## Roles, Transformations, Templates, and Alphabets