vault/website/content/api-docs/system/internal-ui-default-auth-methods.mdx
Erica Thompson 0660ea6fac
Update README (#31244)
* Update README

Let contributors know that docs will now be located in UDR

* Add comments to each mdx doc

Comment has been added to all mdx docs that are not partials

* chore: added changelog

changelog check failure

* wip: removed changelog

* Fix content errors

* Doc spacing

* Update website/content/docs/deploy/kubernetes/vso/helm.mdx

Co-authored-by: Tu Nguyen <im2nguyen@users.noreply.github.com>

---------

Co-authored-by: jonathanfrappier <92055993+jonathanfrappier@users.noreply.github.com>
Co-authored-by: Tu Nguyen <im2nguyen@users.noreply.github.com>
2025-07-22 08:12:22 -07:00

58 lines
1.9 KiB
Plaintext

---
layout: api
page_title: /sys/internal/ui/default-auth-methods - HTTP API
description: The '/sys/internal/ui/default-auth-methods' endpoint returns any configured or inherited default and backup auth methods for a given namespace.
---
> [!IMPORTANT]
> **Documentation Update:** Product documentation, which were located in this repository under `/website`, are now located in [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs), colocated with all other product documentation. Contributions to this content should be done in the `web-unified-docs` repo, and not this one. Changes made to `/website` content in this repo will not be reflected on the developer.hashicorp.com website.
# `/sys/internal/ui/default-auth-methods`
@include 'alerts/enterprise-only.mdx'
`/sys/internal/ui/default-auth-methods` is a Vault-internal endpoint used to
return the explicit, or inherited, default and backup auth method types for a
given namespace.
The namespace is derived from the request itself in the `X-Vault-Namespace` header.
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 UI default login configuration
@include 'alerts/unrestricted.mdx'
Return any configured, or inherited, default and backup authentication methods
for a given namespace.
| Method | Path |
| :----- | :------------------------------------------ |
| `GET` | `/sys/internal/ui/default-auth-methods` |
### Sample request
```shell-session
$ curl
-- header "X-Vault-Namespace: it-admins" \
--request LIST \
http://127.0.0.1:8200/v1/sys/internal/ui/default-auth-methods
```
### Sample response
```json
{
"data": {
"backup_auth_types": [
"token",
"userpass"
],
"default_auth_type": "ldap",
"disable_inheritance": false
},
}
```