luxolus/open-vault
2
0
Fork 0
Code Issues 1 Pull requests Releases Activity

Update website docs to indicate sudo being required for auth/audit

Browse source 
endpoints.
This commit is contained in:
Jeff Mitchell 2016-09-19 12:04:45 -04:00
parent 97dc0e9f64
commit 85c51fd861
2 changed files with 19 additions and 12 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
website/source/docs/http/sys-audit.html.md
View file

@ -13,7 +13,8 @@ description: |-
<dl>
<dt>Description</dt>
<dd>
List the mounted audit backends.
List the mounted audit backends. _This endpoint requires `sudo`
capability._
</dd>
<dt>Method</dt>
@ -47,7 +48,7 @@ description: |-
<dl>
<dt>Description</dt>
<dd>
Enable an audit backend.
Enable an audit backend. _This endpoint requires `sudo` capability._
</dd>
<dt>Method</dt>
@ -89,7 +90,8 @@ description: |-
<dl>
<dt>Description</dt>
<dd>
Disable the given audit backend.
Disable the given audit backend. _This endpoint requires `sudo`
capability._
</dd>
<dt>Method</dt>

23
website/source/docs/http/sys-auth.html.md
View file

@ -44,11 +44,11 @@ description: |-
<dl>
<dt>Description</dt>
<dd>
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`.
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`. _This endpoint requires
`sudo` capability on the final path._
</dd>
<dt>Method</dt>
@ -83,7 +83,8 @@ description: |-
<dl>
<dt>Description</dt>
<dd>
Disable the auth backend at the given auth path.
Disable the auth backend at the given auth path. _This endpoint requires
`sudo` capability on the final path._
</dd>
<dt>Method</dt>
@ -109,8 +110,10 @@ description: |-
<dt>Description</dt>
<dd>
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.
in seconds for each TTL, which may be the system default or a auth path
specific value. _This endpoint requires `sudo` capability on the final
path, but the same functionality can be achieved without `sudo` via
`sys/mounts/auth/[auth_path]/tune`._
</dd>
<dt>Method</dt>
@ -142,7 +145,9 @@ description: |-
<dl>
<dt>Description</dt>
<dd>
Tune configuration parameters for a given auth path.
Tune configuration parameters for a given auth path. _This endpoint
requires `sudo` capability on the final path, but the same functionality
can be achieved without `sudo` via `sys/mounts/auth/[auth_path]/tune`._
</dd>
<dt>Method</dt>