added delete role to website documentation (#27883)

* added delete role to website documentation

* added changlog
This commit is contained in:
kevin-loehfelm 2024-07-26 18:18:45 -04:00 committed by GitHub
parent 32fdae08d6
commit 7c13168d7d
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
2 changed files with 26 additions and 0 deletions

3
changelog/27883.txt Normal file
View file

@ -0,0 +1,3 @@
```release-note:improvement
website/docs: Added API documentation for Azure Secrets Engine delete role
```

View file

@ -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: <required>)`  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.