luxolus
/
open-vault
2
0
Fork 0
Code Issues 1 Pull Requests Releases Activity
open-vault/website/source/docs/http/sys-auth.html.md

1.7 KiB
Raw Blame History

layout page_title sidebar_current description
http HTTP API: /sys/auth docs-http-auth-auth The `/sys/auth` endpoint is used to manage auth backends in Vault.

/sys/auth

GET

Description
Lists all the enabled auth backends.
Method
GET
Parameters
None
Returns
```javascript
{
  "github": {
    "type": "github",
    "description": "GitHub auth"
  }
}
```

POST

Description
Enable a new auth backend. The auth backend can be accessed and configured via the mount point specified in the URL. This mount point will be exposed under the `auth` prefix. For example, enabling with the `/sys/auth/foo` URL will make the backend available at `/auth/foo`.
Method
POST
URL
`/sys/auth/`
Parameters
  • type required The name of the auth backend type, such as "github"
  • description optional A human-friendly description of the auth backend.
Returns
`204` response code.

DELETE

Description
Disable the auth backend at the given mount point.
Method
DELETE
URL
`/sys/auth/`
Parameters
None
Returns
`204` response code.