From 538bb799e49ba12e6b6fec9877d7a03b2225d239 Mon Sep 17 00:00:00 2001 From: Rowan Smith <86935689+rowansmithhc@users.noreply.github.com> Date: Tue, 28 Feb 2023 07:08:15 +1100 Subject: [PATCH] approle naming syntax documentation (#19369) Documentation does not currently detail the accepted naming scheme for approle roles, this aims to provide clarity based on customer feedback. https://github.com/hashicorp/vault/blob/main/sdk/framework/path.go#L16-L18 details the regex used. --- website/content/api-docs/auth/approle.mdx | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/website/content/api-docs/auth/approle.mdx b/website/content/api-docs/auth/approle.mdx index 2e10ac7e6b..24363a8596 100644 --- a/website/content/api-docs/auth/approle.mdx +++ b/website/content/api-docs/auth/approle.mdx @@ -60,7 +60,8 @@ enabled while creating or updating a role. ### Parameters -- `role_name` `(string: )` - Name of the AppRole. Must be less than 4096 bytes. +- `role_name` `(string: )` - Name of the AppRole. Must be less than 4096 bytes, accepted characters +include a-Z, 0-9, space, hyphen, underscore and periods. - `bind_secret_id` `(bool: true)` - Require `secret_id` to be presented when logging in using this AppRole. - `secret_id_bound_cidrs` `(array: [])` - Comma-separated string or list of CIDR