scottk/vault
1
0
Fork 0
mirror of https://github.com/optim-enterprises-bv/vault.git synced 2025-11-01 19:17:58 +00:00
Code Issues Packages Projects Releases Wiki Activity

VAULT-23051: Documenting API Endpoints (#24845)

Browse Source 
* api documentation changes

* document management endpoints

* add new website page to the navigation

* include explanation message retrieval from namespaces up to root namespace

* added clarification statement to the create and update operations documentation

* fixed inconsistency in sample request

* Apply suggestions from code review

Co-authored-by: Jonathan Frappier <92055993+jonathanfrappier@users.noreply.github.com>

---------

Co-authored-by: Jonathan Frappier <92055993+jonathanfrappier@users.noreply.github.com>
This commit is contained in:
Marc Boudreau
2024-01-19 16:13:03 -05:00
committed by GitHub
parent d65f562f84
commit dcde458e33
5 changed files with 379 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

58
website/content/api-docs/system/internal-ui-unauthenticated-messages.mdx Normal file
View File

@@ -0,0 +1,58 @@
---
layout: api
page_title: /sys/internal/ui/unauthenticated-messages - HTTP API
description: >-
The `/sys/internal/ui/unauthenticated-messages` endpoint retrieves active pre-login custom messages.
---
# `/sys/internal/ui/unauthenticated-messages`
The `/sys/internal/ui/unauthenticated-messages` endpoint is used by the UI to
retrieve the active pre-login custom messages so that it can display them.
When retrieving custom messages, the results will include active messages from
the current namespace along with custom messages that exist all of the ancestral
namespaces up to and including the root namespace.
This should only be used internally by the UI. Due to the nature of its
intended usage, there is no guarantee on backwards compatibility for this endpoint.
## Get pre-login custom messages
This endpoint lists the active pre-login custom messages.
| Method | Path |
| :----- | :------------------------------------------ |
| `GET` | `/sys/internal/ui/unauthenticated-messages` |
### Sample request
```shell-session
$ curl \
http://127.0.0.1:8200/v1/sys/internal/ui/unauthenticated-messages
```
### Sample response
```json
{
"data": {
"key_info": {
"01234567-89ab-cdef-0123-456789abcdef": {
"title": "Pre-login Warning",
"message": "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Curabitur nulla augue, placerat quis risus blandit, molestie imperdiet massa. Sed blandit rutrum odio quis varius. Fusce purus orci, maximus ac libero.",
"type": "modal",
"authenticated": false,
"start_time": "2024-01-01T00:00:00.000000000Z",
"end_time": null,
"options": null,
"link": {
"Details": "https://www.example.org/details"
}
}
},
"keys": [
"01234567-89ab-cdef-0123-456789abcdef"
]
}
}
```