Liking cljdoc? Tell your friends :D
Clojure only.

vault.sys.auth

The /sys/auth endpoint is used to list, create, update, and delete auth methods. Auth methods convert user or machine-supplied information into a token which can be used for all future requests.

Reference: https://www.vaultproject.io/api-docs/system/auth

The `/sys/auth` endpoint is used to list, create, update, and delete auth
methods. Auth methods convert user or machine-supplied information into a
token which can be used for all future requests.

Reference: https://www.vaultproject.io/api-docs/system/auth
raw docstring

APIcljprotocol

The health endpoint is used to check the health status of Vault.

The health endpoint is used to check the health status of Vault.

disable-method!clj

(disable-method! client path)

Disable the auth method at the given path. Returns nil.

Disable the auth method at the given path. Returns nil.

enable-method!clj

(enable-method! client path params)

Enable a new auth method at the given path under the auth/ prefix. After enabling, the method can be accessed and configured via the specified path. Returns nil.

Parameters:

  • :type (string)

    Name of the authentication method type, such as "github" or "token".

  • :description (optional, string)

    Human-friendly description of the auth method.

  • :config (optional, map)

    Configuration options for this auth method.

See the Vault API docs for details.

Enable a new auth method at the given path under the `auth/` prefix. After
enabling, the method can be accessed and configured via the specified path.
Returns nil.

Parameters:

- `:type` (string)

  Name of the authentication method type, such as "github" or "token".

- `:description` (optional, string)

  Human-friendly description of the auth method.

- `:config` (optional, map)

  Configuration options for this auth method.

See the Vault API docs for details.

list-methodsclj

(list-methods client)

List all enabled auth methods. Returns a map of endpoints to their configurations.

List all enabled auth methods. Returns a map of endpoints to their
configurations.

read-method-tuningclj

(read-method-tuning client path)

Read the tuning configuration for the auth method at the path. Returns a map of config.

Read the tuning configuration for the auth method at the path. Returns a
map of config.

tune-method!clj

(tune-method! client path params)

Tune the configuration parameters for the auth method at the path. Returns nil.

See the Vault API docs for available parameters.

Tune the configuration parameters for the auth method at the path. Returns
`nil`.

See the Vault API docs for available parameters.
sourceraw docstring

cljdoc is a website building & hosting documentation for Clojure/Script libraries

× close