From 7c13168d7d3b0042ae04cca54ee1c094e0da7e98 Mon Sep 17 00:00:00 2001 From: kevin-loehfelm <37027455+kevin-loehfelm@users.noreply.github.com> Date: Fri, 26 Jul 2024 18:18:45 -0400 Subject: [PATCH] added delete role to website documentation (#27883) * added delete role to website documentation * added changlog --- changelog/27883.txt | 3 +++ website/content/api-docs/secret/azure.mdx | 23 +++++++++++++++++++++++ 2 files changed, 26 insertions(+) create mode 100644 changelog/27883.txt diff --git a/changelog/27883.txt b/changelog/27883.txt new file mode 100644 index 0000000000..63752f78f1 --- /dev/null +++ b/changelog/27883.txt @@ -0,0 +1,3 @@ +```release-note:improvement +website/docs: Added API documentation for Azure Secrets Engine delete role +``` \ No newline at end of file diff --git a/website/content/api-docs/secret/azure.mdx b/website/content/api-docs/secret/azure.mdx index 200c3b188b..c899fdadcb 100644 --- a/website/content/api-docs/secret/azure.mdx +++ b/website/content/api-docs/secret/azure.mdx @@ -295,6 +295,29 @@ $ vault list azure/roles } ``` +## Delete role + +This endpoint deletes an existing role by the given name. If the role does not +exist, a 404 is returned. + +| Method | Path | +| :------- | :----------------- | +| `DELETE` | `/azure/roles/:name` | + +### Parameters + +- `name` `(string: )` – Specifies the name of the role to delete. This + is part of the request URL. + +### Sample request + +```shell-session +$ curl \ + --header "X-Vault-Token: ..." \ + --request DELETE \ + http://127.0.0.1:8200/v1/azure/roles/example-role +``` + ## Generate credentials This endpoint generates a new service principal based on the named role.