Sign in

v1

latestOpenAPI 3.0.2Mozilla Public License 2.02026-07-17307105155.2 KB
system

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.

post/sys/auth/{path}/tune

Request body

allowed_response_headersstring[]

A list of headers to whitelist and allow a plugin to set on responses.

audit_non_hmac_request_keysstring[]

The list of keys in the request data object that will not be HMAC'ed by audit devices.

audit_non_hmac_response_keysstring[]

The list of keys in the response data object that will not be HMAC'ed by audit devices.

default_lease_ttlstring

The default lease TTL for this mount.

descriptionstring

User-friendly description for this credential backend.

listing_visibilitystring

Determines the visibility of the mount in the UI-specific listing endpoint. Accepted value are 'unauth' and 'hidden', with the empty default ('') behaving like 'hidden'.

max_lease_ttlstring

The max lease TTL for this mount.

optionsobject

The options to pass into the backend. Should be a json object with string keys and values.

passthrough_request_headersstring[]

A list of headers to whitelist and pass from the request to the plugin.

plugin_versionstring

The semantic version of the plugin to use.

token_typestring

The type of token to issue (service or batch).

Response

OK