Skip to content

Commit

Permalink
Add docs about path param restrictions (hashicorp#13413)
Browse files Browse the repository at this point in the history
* Add docs about path param restrictions

* Update website/content/api-docs/auth/userpass.mdx

Co-authored-by: Loann Le <84412881+taoism4504@users.noreply.github.com>

* Update with review suggestion

Co-authored-by: Loann Le <84412881+taoism4504@users.noreply.github.com>
  • Loading branch information
2 people authored and heppu committed Jan 13, 2022
1 parent 3e5f13a commit 1316c8a
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 1 deletion.
2 changes: 1 addition & 1 deletion website/content/api-docs/auth/userpass.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ Create a new user or update an existing user. This path honors the distinction b

### Parameters

- `username` `(string: <required>)` – The username for the user. Accepted characters: alphanumeric plus "_", "-", "." (underscore, hyphen and period); username cannot begin with hyphen or period.
- `username` `(string: <required>)` – The username for the user. Accepted characters: alphanumeric plus "_", "-", "." (underscore, hyphen and period); username cannot begin with a hyphen, nor can it begin or end with a period.
- `password` `(string: <required>)` - The password for the user. Only required
when creating the user.

Expand Down
5 changes: 5 additions & 0 deletions website/content/api-docs/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,11 @@ Responses from auth login methods that generate an authentication token are
sent back to the client via JSON. The resulting token should be saved on the
client or passed via the `X-Vault-Token` or `Authorization` header for future requests.

## Parameter restrictions

Several Vault APIs require specifying path parameters. The path parameter cannot end
in periods. Otherwise, Vault will return a 404 unsupported path error.

## Namespaces

If using the [Namespaces](/docs/enterprise/namespaces) feature, API
Expand Down

0 comments on commit 1316c8a

Please sign in to comment.