3.1 KiB
3.1 KiB
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 auth path specified in the URL. This auth path 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 auth path.
- Method
- DELETE
- URL
- `/sys/auth/`
- Parameters
- None
- Returns
- `204` response code.
/sys/auth/[auth_path]/tune
GET
- Description
- Read the given auth path's configuration. Returns the current time in seconds for each TTL, which may be the system default or a auth path specific value.
- Method
- GET
- URL
- `/sys/auth//tune`
- Parameters
- None
- Returns
-
```javascript { "default_lease_ttl": 3600, "max_lease_ttl": 7200 } ```
POST
- Description
- Tune configuration parameters for a given auth path.
- Method
- POST
- URL
- `/sys/auth//tune`
- Parameters
-
- default_lease_ttl optional The default time-to-live. If set on a specific auth path, overrides the global default. A value of "system" or "0" are equivalent and set to the system default TTL.
- max_lease_ttl optional The maximum time-to-live. If set on a specific auth path, overrides the global default. A value of "system" or "0" are equivalent and set to the system max TTL.
- Returns
- `204` response code.