Spring Vault

https://docs.spring.io/spring-vault/docs/current/
Admin
Spring Vault provides client-side integration for HashiCorp Vault, simplifying access to secrets,...
Tokens:404,801
Snippets:5,584
Trust Score:10
Update:1 week ago
Show doc for...
Tokens:
Raw
### SslConfiguration.withKeyStore(SslConfiguration.KeyStoreConfiguration configuration, SslConfiguration.KeyConfiguration keyConfiguration)

Source: https://docs.spring.io/spring-vault/docs/current/api/org/springframework/vault/support/class-use/SslConfiguration.KeyStoreConfiguration.html

Creates a new `SslConfiguration` with `SslConfiguration.KeyStoreConfiguration` and `SslConfiguration.KeyConfiguration` applied retaining the trust store configuration.

```APIDOC
## SslConfiguration.withKeyStore(SslConfiguration.KeyStoreConfiguration configuration, SslConfiguration.KeyConfiguration keyConfiguration)

### Description
Creates a new `SslConfiguration` with `SslConfiguration.KeyStoreConfiguration` and `SslConfiguration.KeyConfiguration` applied retaining the trust store configuration.

### Method
instance method

### Signature
`public SslConfiguration withKeyStore(SslConfiguration.KeyStoreConfiguration configuration, SslConfiguration.KeyConfiguration keyConfiguration)`

### Parameters
- **configuration** (SslConfiguration.KeyStoreConfiguration) - Required - The key store configuration to apply.
- **keyConfiguration** (SslConfiguration.KeyConfiguration) - Required - The key configuration to apply.

### Returns
- **SslConfiguration** - A new `SslConfiguration` instance.
```

--------------------------------

### SecretLeaseContainer usage example

Source: https://docs.spring.io/spring-vault/docs/current/api/org/springframework/vault/core/lease/SecretLeaseContainer.html

Shows how to create a SecretLeaseContainer, request a rotating secret, add a lease listener, and start the container. Events are triggered only after calling start().

```java
SecretLeaseContainer container = new SecretLeaseContainer(vaultOperations,
                taskScheduler);
 RequestedSecret requestedSecret = container
                .requestRotatingSecret("mysql/creds/my-role");
 container.addLeaseListener(new LeaseListenerAdapter() {
        @Override
        public void onLeaseEvent(SecretLeaseEvent secretLeaseEvent) {
                if (requestedSecret == secretLeaseEvent.getSource()) {
                        if (secretLeaseEvent instanceof SecretLeaseCreatedEvent) {
            }
                        if (secretLeaseEvent instanceof SecretLeaseExpiredEvent) {
            }
        }
    }
 });
 container.afterPropertiesSet();
 container.start(); // events are triggered after starting the container
```

--------------------------------

### AWS-EC2 authentication flow using AuthenticationSteps

Source: https://docs.spring.io/spring-vault/docs/current/api/org/springframework/vault/authentication/AuthenticationSteps.html

Shows how to start an authentication flow from an HTTP request, transform the response, and perform a login. The example uses a nonce and PKCS7 from the identity document to build a login map.

```java
String nonce = "";
return AuthenticationSteps
                .fromHttpRequest(
                                HttpRequestBuilder.get(options.getIdentityDocumentUri().toString()) //
                                                .as(String.class)) //
                .map(pkcs7 -> pkcs7.replaceAll("\\r", "")) //
                .map(pkcs7 -> {

                        Map<String, String> login = new HashMap<>();

                        login.put("nonce", new String(nonce));
                        login.put("pkcs7", pkcs7);

                        return login;
                }).login(AuthenticationUtil.getLoginPath(options.getPath()));
```

--------------------------------

### build()

Source: https://docs.spring.io/spring-vault/docs/current/api/org/springframework/vault/client/WebClientBuilder.html

Builds a new WebClient instance using the configured settings.

```APIDOC
## WebClient build()

### Description
Builds a new `WebClient` instance using the configured settings.

### Method
build

### Return Type
`WebClient`

### Usage
```java
WebClient webClient = WebClientBuilder.builder().build();
```
```

--------------------------------

### PcfAuthenticationOptions.PcfAuthenticationOptionsBuilder.build()

Source: https://docs.spring.io/spring-vault/docs/current/api/org/springframework/vault/authentication/class-use/PcfAuthenticationOptions.html

Builds a new PcfAuthenticationOptions instance.

```APIDOC
## PcfAuthenticationOptions.PcfAuthenticationOptionsBuilder.build()

### Description
Build a new `PcfAuthenticationOptions` instance.

### Method
build

### Signature
`PcfAuthenticationOptions build()`

### Returns
- `PcfAuthenticationOptions` - A new `PcfAuthenticationOptions` instance.
```

--------------------------------

### start

Source: https://docs.spring.io/spring-vault/docs/current/api/org/springframework/vault/core/lease/SecretLeaseContainer.html

Starts the SecretLeaseContainer.

```APIDOC
## start

### Description
Start the `SecretLeaseContainer`. Starting the container will initially obtain secrets and leases for the requested secrets. A started container publishes events through `LeaseListener`. Additional secrets can be requested at any time. Multiple calls are synchronized to start the container only once. Container start requires `initialization` and cannot be started once the container was `destroyed`.

### Method
START

### Endpoint
`start()`

### See Also
- `afterPropertiesSet()`
- `stop()`
```

--------------------------------

### SslConfiguration(SslConfiguration.KeyStoreConfiguration keyStoreConfiguration, SslConfiguration.KeyConfiguration keyConfiguration, SslConfiguration.KeyStoreConfiguration trustStoreConfiguration, List<String> enabledProtocols, List<String> enabledCipherSuites)

Source: https://docs.spring.io/spring-vault/docs/current/api/org/springframework/vault/support/class-use/SslConfiguration.KeyStoreConfiguration.html

Creates a new `SslConfiguration`.

```APIDOC
## SslConfiguration(SslConfiguration.KeyStoreConfiguration keyStoreConfiguration, SslConfiguration.KeyConfiguration keyConfiguration, SslConfiguration.KeyStoreConfiguration trustStoreConfiguration, List<String> enabledProtocols, List<String> enabledCipherSuites)

### Description
Creates a new `SslConfiguration`.

### Method
constructor

### Signature
`public SslConfiguration(SslConfiguration.KeyStoreConfiguration keyStoreConfiguration, SslConfiguration.KeyConfiguration keyConfiguration, SslConfiguration.KeyStoreConfiguration trustStoreConfiguration, List<String> enabledProtocols, List<String> enabledCipherSuites)`

### Parameters
- **keyStoreConfiguration** (SslConfiguration.KeyStoreConfiguration) - Required - The key store configuration.
- **keyConfiguration** (SslConfiguration.KeyConfiguration) - Required - The key configuration.
- **trustStoreConfiguration** (SslConfiguration.KeyStoreConfiguration) - Required - The trust store configuration.
- **enabledProtocols** (List<String>) - Required - The enabled protocols.
- **enabledCipherSuites** (List<String>) - Required - The enabled cipher suites.
```

--------------------------------

### get()

Source: https://docs.spring.io/spring-vault/docs/current/api/org/springframework/vault/authentication/CredentialSupplier.html

Get a credential to be used with an authentication mechanism.

```APIDOC
## [GET] get()

### Description
Get a credential to be used with an authentication mechanism.

### Method
GET

### Endpoint
get()

### Parameters
None

### Response
#### Success Response (200)
- **credential** (String) - The credential to be used with an authentication mechanism.

#### Response Example
{
  "credential": "example-credential-value"
}
```

--------------------------------

### createKeyStore(String, CharSequence)

Source: https://docs.spring.io/spring-vault/docs/current/api/index-all.html

Creates a KeyStore from a CertificateBundle with password and key password as CharSequence.

```APIDOC
## createKeyStore(String, CharSequence)

### Description
Create a `KeyStore` from this `CertificateBundle` containing the private key and certificate chain.

### Method
createKeyStore

### Parameters
- **password** (String) - Required - The password to protect the keystore.
- **keyPassword** (CharSequence) - Required - The password for the private key.

### Return
A `KeyStore` containing the private key and certificate chain.
```

--------------------------------

### get()

Source: https://docs.spring.io/spring-vault/docs/current/api/org/springframework/vault/authentication/GoogleCredentialsSupplier.html

Exception-safe helper to get ServiceAccountCredentials from getCredentials(). This is a default method that wraps the credentials retrieval.

```APIDOC
## get()

### Description
Exception-safe helper to get `ServiceAccountCredentials` from `getCredentials()`.

### Method Signature
`default com.google.auth.oauth2.GoogleCredentials get()`

### Returns
- **com.google.auth.oauth2.GoogleCredentials** - the ServiceAccountCredentials for JWT signing.

### Notes
- This method is specified by `get` in interface `Supplier<com.google.auth.oauth2.GoogleCredentials>`.
```

--------------------------------

### get(String uriTemplate, String... uriVariables)

Source: https://docs.spring.io/spring-vault/docs/current/api/org/springframework/vault/authentication/AuthenticationSteps.HttpRequestBuilder.html

Builder entry point to GET from uriTemplate.

```APIDOC
## [GET] get(String uriTemplate, String... uriVariables)

### Description
Builder entry point to `GET` from `uriTemplate`.

### Method
GET

### Parameters
#### Path Parameters
- **uriTemplate** (String) - Required - must not be null or empty.
- **uriVariables** (String...) - Optional - the variables to expand the template.

### Returns
A new `AuthenticationSteps.HttpRequestBuilder`.
```

--------------------------------

### SslConfiguration.KeyStoreConfiguration.of(Resource resource)

Source: https://docs.spring.io/spring-vault/docs/current/api/org/springframework/vault/support/class-use/SslConfiguration.KeyStoreConfiguration.html

Creates a new `SslConfiguration.KeyStoreConfiguration` given a `Resource`.

```APIDOC
## SslConfiguration.KeyStoreConfiguration.of(Resource resource)

### Description
Creates a new `SslConfiguration.KeyStoreConfiguration` given a `Resource`.

### Method
static factory method

### Signature
`public static SslConfiguration.KeyStoreConfiguration of(Resource resource)`

### Parameters
- **resource** (Resource) - Required - The resource representing the keystore.

### Returns
- **SslConfiguration.KeyStoreConfiguration** - A new `SslConfiguration.KeyStoreConfiguration` instance.
```

--------------------------------

### forKeyStore(Resource, char[], KeyConfiguration)

Source: https://docs.spring.io/spring-vault/docs/current/api/org/springframework/vault/support/SslConfiguration.html

Creates a new SslConfiguration for the given key store with the default KeyStore type and key configuration.

```APIDOC
## forKeyStore(Resource, char[], KeyConfiguration)

### Description
Creates a new `SslConfiguration` for the given key store with the default `KeyStore` type.

### Method
Static factory method

### Signature
`public static SslConfiguration forKeyStore(Resource keyStore, @Nullable char[] keyStorePassword, SslConfiguration.KeyConfiguration keyConfiguration)`

### Parameters
- `keyStore` (Resource) - Required - Resource pointing to an existing key store, must not be null.
- `keyStorePassword` (char[]) - Optional - May be null.
- `keyConfiguration` (SslConfiguration.KeyConfiguration) - Required - The configuration for a specific key in `keyStoreConfiguration` to use.

### Returns
The created `SslConfiguration`.

### Since
2.2

### See Also
- `KeyStore`
```

--------------------------------

### get()

Source: https://docs.spring.io/spring-vault/docs/current/api/org/springframework/vault/authentication/GcpCredentialSupplier.html

Exception-safe helper to get GoogleCredential from getCredential(). This is a default method that delegates to getCredential() and handles exceptions.

```APIDOC
## get()

### Description
Exception-safe helper to get `GoogleCredential` from `getCredential()`. This is a default method that delegates to `getCredential()` and handles exceptions.

### Method
`default com.google.api.client.googleapis.auth.oauth2.GoogleCredential get()`

### Returns
- `com.google.api.client.googleapis.auth.oauth2.GoogleCredential` - the GoogleCredential for JWT signing.

### Notes
- This method is specified by `get` in interface `Supplier<com.google.api.client.googleapis.auth.oauth2.GoogleCredential>`.
```

--------------------------------

### fromSupplier

Source: https://docs.spring.io/spring-vault/docs/current/api/org/springframework/vault/authentication/AuthenticationSteps.html

Starts flow composition from a supplier.

```APIDOC
## fromSupplier

### Description
Starts flow composition from a `Supplier`. This static method allows the authentication flow to begin with a supplier that provides the initial value.

### Method
static <T> AuthenticationSteps.Node<T>

### Signature
`public static <T> AuthenticationSteps.Node<T> fromSupplier(Supplier<T> supplier)`

### Parameters
- **supplier** (Supplier<T>) - Required - The supplier that provides the initial value.

### Returns
- **AuthenticationSteps.Node<T>** - An intermediate authentication step node.

### Example
```java
AuthenticationSteps.fromSupplier(() -> "some-value")
```
```

--------------------------------

### createKeyStore(String, char[])

Source: https://docs.spring.io/spring-vault/docs/current/api/index-all.html

Creates a KeyStore from a CertificateBundle with password and key password.

```APIDOC
## createKeyStore(String, char[])

### Description
Create a `KeyStore` from this `CertificateBundle` containing the private key and certificate chain.

### Method
createKeyStore

### Parameters
- **password** (String) - Required - The password to protect the keystore.
- **keyPassword** (char[]) - Required - The password for the private key.

### Return
A `KeyStore` containing the private key and certificate chain.
```

--------------------------------

### withKeyStore(SslConfiguration.KeyStoreConfiguration, SslConfiguration.KeyConfiguration)

Source: https://docs.spring.io/spring-vault/docs/current/api/org/springframework/vault/support/SslConfiguration.html

Instance method that creates a new SslConfiguration with the given key store and key configuration applied, retaining the trust store configuration.

```APIDOC
## withKeyStore(SslConfiguration.KeyStoreConfiguration, SslConfiguration.KeyConfiguration)

### Description
Creates a new `SslConfiguration` with `SslConfiguration.KeyStoreConfiguration` and `SslConfiguration.KeyConfiguration` applied retaining the `trust store` configuration.

### Method
Instance Method

### Signature
`SslConfiguration withKeyStore(SslConfiguration.KeyStoreConfiguration configuration, SslConfiguration.KeyConfiguration keyConfiguration)`

### Parameters
- `configuration` (SslConfiguration.KeyStoreConfiguration) - Required - the key store configuration to apply.
- `keyConfiguration` (SslConfiguration.KeyConfiguration) - Required - the key configuration to apply.

### Returns
- `SslConfiguration` - a new `SslConfiguration` with the key store and key configuration applied.
```

--------------------------------

### Versioned.Metadata.getVersion

Source: https://docs.spring.io/spring-vault/docs/current/api/org/springframework/vault/support/class-use/Versioned.Version.html

Gets the version of a Metadata object.

```APIDOC
## Versioned.Metadata.getVersion

### Description
Returns the version of this Metadata object.

### Returns
- **Versioned.Version** - The version.

```

--------------------------------

### getAuthMounts()

Source: https://docs.spring.io/spring-vault/docs/current/api/org/springframework/vault/core/VaultSysOperations.html

Gets all auth backend mounts.

```APIDOC
## getAuthMounts()

### Description
Returns a Map of all auth backend mounts.

### Method
GET

### Endpoint
/sys/auth/

### Returns
- **Map<String,VaultMount>** - Map of all auth backend mounts.

### Throws
- **VaultException** - if the operation fails.
```

--------------------------------

### SslConfiguration.withKeyStore(SslConfiguration.KeyStoreConfiguration configuration)

Source: https://docs.spring.io/spring-vault/docs/current/api/org/springframework/vault/support/class-use/SslConfiguration.html

Creates a new SslConfiguration with KeyStoreConfiguration applied, retaining the trust store configuration.

```APIDOC
## SslConfiguration.withKeyStore(SslConfiguration.KeyStoreConfiguration configuration)

### Description
Creates a new SslConfiguration with KeyStoreConfiguration applied, retaining the trust store configuration.

### Method
Instance method

### Parameters
- **configuration** (SslConfiguration.KeyStoreConfiguration) - Required - The key store configuration.

### Returns
- **SslConfiguration** - A new SslConfiguration instance.

```

--------------------------------

### withKeyStore(SslConfiguration.KeyStoreConfiguration)

Source: https://docs.spring.io/spring-vault/docs/current/api/org/springframework/vault/support/SslConfiguration.html

Instance method that creates a new SslConfiguration with the given key store configuration applied, retaining the trust store configuration.

```APIDOC
## withKeyStore(SslConfiguration.KeyStoreConfiguration)

### Description
Creates a new `SslConfiguration` with `SslConfiguration.KeyStoreConfiguration` applied retaining the `trust store` configuration.

### Method
Instance Method

### Signature
`SslConfiguration withKeyStore(SslConfiguration.KeyStoreConfiguration configuration)`

### Parameters
- `configuration` (SslConfiguration.KeyStoreConfiguration) - Required - the key store configuration to apply.

### Returns
- `SslConfiguration` - a new `SslConfiguration` with the key store configuration applied.
```

--------------------------------

### getMounts()

Source: https://docs.spring.io/spring-vault/docs/current/api/org/springframework/vault/core/VaultSysOperations.html

Gets all secret backend mounts.

```APIDOC
## getMounts()

### Description
Returns a Map of all secret backend mounts.

### Method
GET

### Endpoint
/sys/mounts/

### Returns
- **Map<String,VaultMount>** - Map of all secret backend mounts.

### Throws
- **VaultException** - if the operation fails.
```

--------------------------------

### getUnsealStatus()

Source: https://docs.spring.io/spring-vault/docs/current/api/org/springframework/vault/core/VaultSysOperations.html

Gets the current unseal status.

```APIDOC
## getUnsealStatus()

### Description
Returns the VaultUnsealStatus.

### Method
GET

### Endpoint
/sys/unseal

### Returns
- **VaultUnsealStatus** - the VaultUnsealStatus.

### Throws
- **VaultException** - if the operation fails.
```

--------------------------------

### create(Resource, char[], Resource, char[])

Source: https://docs.spring.io/spring-vault/docs/current/api/org/springframework/vault/support/SslConfiguration.html

Creates a new SslConfiguration for the given truststore with the default KeyStore type.

```APIDOC
## create(Resource, char[], Resource, char[])

### Description
Creates a new `SslConfiguration` for the given truststore with the default `KeyStore` type.

### Method
Static factory method

### Signature
`public static SslConfiguration create(Resource keyStore, @Nullable char[] keyStorePassword, Resource trustStore, @Nullable char[] trustStorePassword)`

### Parameters
- `keyStore` (Resource) - Required - Resource pointing to an existing keystore, must not be null.
- `keyStorePassword` (char[]) - Optional - May be null.
- `trustStore` (Resource) - Required - Resource pointing to an existing trust store, must not be null.
- `trustStorePassword` (char[]) - Optional - May be null.

### Returns
The created `SslConfiguration`.

### See Also
- `KeyStore`
```

--------------------------------

### fromValue

Source: https://docs.spring.io/spring-vault/docs/current/api/org/springframework/vault/authentication/AuthenticationSteps.html

Starts flow composition from a scalar value.

```APIDOC
## fromValue

### Description
Starts flow composition from a scalar value. This static method allows the authentication flow to begin with a direct value.

### Method
static <T> AuthenticationSteps.Node<T>

### Signature
`public static <T> AuthenticationSteps.Node<T> fromValue(T value)`

### Parameters
- **value** (T) - Required - The scalar value to start the flow with.

### Returns
- **AuthenticationSteps.Node<T>** - An intermediate authentication step node.

### Example
```java
AuthenticationSteps.fromValue("some-value")
```
```

--------------------------------

### forKeyStore(KeyStoreConfiguration, KeyConfiguration)

Source: https://docs.spring.io/spring-vault/docs/current/api/org/springframework/vault/support/SslConfiguration.html

Creates a new SslConfiguration for the given key store and key configuration.

```APIDOC
## forKeyStore(KeyStoreConfiguration, KeyConfiguration)

### Description
Creates a new `SslConfiguration` for the given `key store` and `SslConfiguration.KeyConfiguration`.

### Method
Static factory method

### Signature
`public static SslConfiguration forKeyStore(SslConfiguration.KeyStoreConfiguration keyStore, SslConfiguration.KeyConfiguration keyConfiguration)`

### Parameters
- `keyStore` (SslConfiguration.KeyStoreConfiguration) - Required - Resource pointing to an existing key store, must not be null.
- `keyConfiguration` (SslConfiguration.KeyConfiguration) - Required - The configuration for a specific key in `keyStoreConfiguration` to use.

### Returns
The created `SslConfiguration`.

### Since
2.2

### See Also
- `KeyStore`
```

--------------------------------

### fromHttpRequest

Source: https://docs.spring.io/spring-vault/docs/current/api/org/springframework/vault/authentication/AuthenticationSteps.html

Starts flow composition from an HTTP request.

```APIDOC
## fromHttpRequest

### Description
Starts flow composition from an `AuthenticationSteps.HttpRequest`. This is a static method that serves as an entry point for building an authentication flow based on an HTTP request.

### Method
static <T> AuthenticationSteps.Node<T>

### Signature
`public static <T> AuthenticationSteps.Node<T> fromHttpRequest(AuthenticationSteps.HttpRequest<T> request)`

### Parameters
- **request** (AuthenticationSteps.HttpRequest<T>) - Required - The HTTP request to start the flow from.

### Returns
- **AuthenticationSteps.Node<T>** - An intermediate authentication step node.

### Example
```java
AuthenticationSteps.fromHttpRequest(HttpRequestBuilder.get("https://example.com").as(String.class))
```
```

--------------------------------

### SslConfiguration.forKeyStore(Resource, char[], SslConfiguration.KeyConfiguration)

Source: https://docs.spring.io/spring-vault/docs/current/api/org/springframework/vault/support/class-use/SslConfiguration.html

Creates a new SslConfiguration for the given key store with the default KeyStore type.

```APIDOC
## SslConfiguration.forKeyStore(Resource, char[], SslConfiguration.KeyConfiguration)

### Description
Creates a new `SslConfiguration` for the given key store with the default `KeyStore` type.

### Method
static SslConfiguration

### Signature
`static SslConfiguration forKeyStore(Resource keyStore, char[] keyStorePassword, SslConfiguration.KeyConfiguration keyConfiguration)`

### Parameters
- `keyStore` (Resource) - Required - The key store resource.
- `keyStorePassword` (char[]) - Required - The key store password.
- `keyConfiguration` (SslConfiguration.KeyConfiguration) - Required - The key configuration.

### Returns
A new `SslConfiguration` instance.
```

--------------------------------

### createClient(ClientOptions, SslConfiguration)

Source: https://docs.spring.io/spring-vault/docs/current/api/index-all.html

Creates a client using the given options and SSL configuration.

```APIDOC
## createClient(ClientOptions, SslConfiguration)

### Description
Creates a client using the given options and SSL configuration.

### Method
Static method

### Signature
`createClient(ClientOptions, SslConfiguration)`

### Parameters
- `ClientOptions` - The client options.
- `SslConfiguration` - The SSL configuration.

### Returns
A client object.
```

--------------------------------

### SslConfiguration.unconfigured()

Source: https://docs.spring.io/spring-vault/docs/current/api/org/springframework/vault/support/SslConfiguration.html

Factory method to get an unconfigured SslConfiguration.

```APIDOC
## SslConfiguration.unconfigured()

### Description
Factory method returning an unconfigured `SslConfiguration` instance.

### Method
static factory method

### Signature
`public static SslConfiguration unconfigured()`

### Returns
An unconfigured `SslConfiguration` instance.
```

--------------------------------

### GET /sys/health

Source: https://docs.spring.io/spring-vault/docs/current/api/org/springframework/vault/core/VaultSysTemplate.html

Returns the health status of Vault.

```APIDOC
## GET /sys/health

### Description
Returns the health status of Vault.

### Method
GET

### Endpoint
/sys/health

### Response
#### Success Response (200)
- **VaultHealth** - The health status of Vault.

### See Also
- GET /sys/health
```

--------------------------------

### SslConfiguration.forKeyStore(Resource, char[])

Source: https://docs.spring.io/spring-vault/docs/current/api/org/springframework/vault/support/SslConfiguration.html

Factory method to create an SslConfiguration with a key store resource and password.

```APIDOC
## SslConfiguration.forKeyStore(Resource, char[])

### Description
Creates a new `SslConfiguration` for the given key store with the default `KeyStore` type.

### Method
static factory method

### Signature
`public static SslConfiguration forKeyStore(Resource keyStore, char[] keyStorePassword)`

### Parameters
- **keyStore** (Resource) - Required - The key store resource.
- **keyStorePassword** (char[]) - Required - The key store password.

### Returns
A new `SslConfiguration` instance.
```

--------------------------------

### createKeyStore(String, boolean, CharSequence)

Source: https://docs.spring.io/spring-vault/docs/current/api/index-all.html

Creates a KeyStore from a CertificateBundle with password, export flag, and key password as CharSequence.

```APIDOC
## createKeyStore(String, boolean, CharSequence)

### Description
Create a `KeyStore` from this `CertificateBundle` containing the private key and certificate chain.

### Method
createKeyStore

### Parameters
- **password** (String) - Required - The password to protect the keystore.
- **exportPrivateKey** (boolean) - Required - Whether to export the private key.
- **keyPassword** (CharSequence) - Required - The password for the private key.

### Return
A `KeyStore` containing the private key and certificate chain.
```

--------------------------------

### GET /sys/auth/

Source: https://docs.spring.io/spring-vault/docs/current/api/org/springframework/vault/core/VaultSysTemplate.html

Lists all auth backend mounts.

```APIDOC
## GET /sys/auth/

### Description
Lists all auth backend mounts.

### Method
GET

### Endpoint
/sys/auth/

### Response
#### Success Response (200)
- **Map<String,VaultMount>** - A map of all auth backend mounts.

### See Also
- GET /sys/auth/
```

--------------------------------

### AuthenticationSteps.fromHttpRequest(AuthenticationSteps.HttpRequest<T> request)

Source: https://docs.spring.io/spring-vault/docs/current/api/org/springframework/vault/authentication/class-use/AuthenticationSteps.HttpRequest.html

Starts flow composition from an AuthenticationSteps.HttpRequest.

```APIDOC
## [STATIC] AuthenticationSteps.fromHttpRequest(AuthenticationSteps.HttpRequest<T> request)

### Description
Starts flow composition from a AuthenticationSteps.HttpRequest.

### Method
STATIC

### Parameters
#### Parameters
- **request** (AuthenticationSteps.HttpRequest<T>) - Required - The HTTP request to start the flow from.

### Returns
- **AuthenticationSteps.Node<T>** - The starting node of the flow.
```

--------------------------------

### SslConfiguration(SslConfiguration.KeyStoreConfiguration, SslConfiguration.KeyConfiguration, SslConfiguration.KeyStoreConfiguration)

Source: https://docs.spring.io/spring-vault/docs/current/api/org/springframework/vault/support/SslConfiguration.html

Constructor that creates a new SslConfiguration with key store, key configuration, and trust store.

```APIDOC
## SslConfiguration(SslConfiguration.KeyStoreConfiguration, SslConfiguration.KeyConfiguration, SslConfiguration.KeyStoreConfiguration)

### Description
Creates a new `SslConfiguration` with key store, key configuration, and trust store.

### Method
Constructor

### Signature
`public SslConfiguration(SslConfiguration.KeyStoreConfiguration keyStoreConfiguration, SslConfiguration.KeyConfiguration keyConfiguration, SslConfiguration.KeyStoreConfiguration trustStoreConfiguration)`

### Parameters
- `keyStoreConfiguration` (SslConfiguration.KeyStoreConfiguration) - Required - the key store configuration, must not be null.
- `keyConfiguration` (SslConfiguration.KeyConfiguration) - Required - the configuration for a specific key in `keyStoreConfiguration` to use.
- `trustStoreConfiguration` (SslConfiguration.KeyStoreConfiguration) - Required - the trust store configuration, must not be null.

### Since
2.2
```

--------------------------------

### forKeyStore(Resource, char[])

Source: https://docs.spring.io/spring-vault/docs/current/api/org/springframework/vault/support/SslConfiguration.html

Creates a new SslConfiguration for the given key store with the default KeyStore type.

```APIDOC
## forKeyStore(Resource, char[])

### Description
Creates a new `SslConfiguration` for the given key store with the default `KeyStore` type.

### Method
Static factory method

### Signature
`public static SslConfiguration forKeyStore(Resource keyStore, @Nullable char[] keyStorePassword)`

### Parameters
- `keyStore` (Resource) - Required - Resource pointing to an existing key store, must not be null.
- `keyStorePassword` (char[]) - Optional - May be null.

### Returns
The created `SslConfiguration`.

### See Also
- `KeyStore`
```

--------------------------------

### AuthenticationSteps.fromHttpRequest(AuthenticationSteps.HttpRequest<T> request)

Source: https://docs.spring.io/spring-vault/docs/current/api/org/springframework/vault/authentication/class-use/AuthenticationSteps.HttpRequest.html

Starts flow composition from an AuthenticationSteps.HttpRequest.

```APIDOC
## [STATIC] fromHttpRequest

### Description
Starts flow composition from a AuthenticationSteps.HttpRequest.

### Method
STATIC

### Parameters
#### Parameters
- **request** (AuthenticationSteps.HttpRequest<T>) - Required - The HTTP request to start the flow from.

### Returns
- AuthenticationSteps.Node<T> - The starting node of the flow.
```

--------------------------------

### AuthenticationSteps.fromHttpRequest(AuthenticationSteps.HttpRequest<T> request)

Source: https://docs.spring.io/spring-vault/docs/current/api/org/springframework/vault/authentication/class-use/AuthenticationSteps.HttpRequest.html

Starts flow composition from an AuthenticationSteps.HttpRequest.

```APIDOC
## [STATIC] fromHttpRequest

### Description
Starts flow composition from a AuthenticationSteps.HttpRequest.

### Method
static

### Signature
`<T> AuthenticationSteps.Node<T> fromHttpRequest(AuthenticationSteps.HttpRequest<T> request)`

### Parameters
- **request** (AuthenticationSteps.HttpRequest<T>) - Required - The HTTP request to start the flow from.

### Returns
- `AuthenticationSteps.Node<T>` - The starting node of the flow.
```

--------------------------------

### SslConfiguration(SslConfiguration.KeyStoreConfiguration, SslConfiguration.KeyStoreConfiguration, List<String>, List<String>)

Source: https://docs.spring.io/spring-vault/docs/current/api/org/springframework/vault/support/SslConfiguration.html

Constructor that creates a new SslConfiguration with key store, trust store, enabled protocols, and enabled cipher suites.

```APIDOC
## SslConfiguration(SslConfiguration.KeyStoreConfiguration, SslConfiguration.KeyStoreConfiguration, List<String>, List<String>)

### Description
Creates a new `SslConfiguration` with key store, trust store, enabled protocols, and enabled cipher suites.

### Method
Constructor

### Signature
`public SslConfiguration(SslConfiguration.KeyStoreConfiguration keyStoreConfiguration, SslConfiguration.KeyStoreConfiguration trustStoreConfiguration, List<String> enabledProtocols, List<String> enabledCipherSuites)`

### Parameters
- `keyStoreConfiguration` (SslConfiguration.KeyStoreConfiguration) - Required - the key store configuration, must not be null.
- `trustStoreConfiguration` (SslConfiguration.KeyStoreConfiguration) - Required - the trust store configuration, must not be null.
- `enabledProtocols` (List<String>) - Optional - the enabled SSL protocols, elements must match protocol version strings used by the enabled Java SSL provider. May be null to indicate the SSL socket factory should use a default list of enabled protocol versions.
- `enabledCipherSuites` (List<String>) - Optional - the enabled SSL cipher suites, elements must match cipher suite strings used by the enabled Java SSL provider. May be null to indicate the SSL socket factory should use a default list of enabled cipher suites.

### Since
2.3.2
```

--------------------------------

### AuthenticationSteps.fromHttpRequest(AuthenticationSteps.HttpRequest<T> request)

Source: https://docs.spring.io/spring-vault/docs/current/api/org/springframework/vault/authentication/class-use/AuthenticationSteps.HttpRequest.html

Starts flow composition from an AuthenticationSteps.HttpRequest.

```APIDOC
## AuthenticationSteps.fromHttpRequest(AuthenticationSteps.HttpRequest<T> request)

### Description
Starts flow composition from an AuthenticationSteps.HttpRequest.

### Method
static

### Parameters
- **request** (AuthenticationSteps.HttpRequest<T>) - Required - The HTTP request to start the flow from.

### Returns
- AuthenticationSteps.Node<T> - The starting node of the flow.
```

--------------------------------

### createKeyStore(String, boolean, char[])

Source: https://docs.spring.io/spring-vault/docs/current/api/index-all.html

Creates a KeyStore from a CertificateBundle with password, export flag, and key password.

```APIDOC
## createKeyStore(String, boolean, char[])

### Description
Create a `KeyStore` from this `CertificateBundle` containing the private key and certificate chain.

### Method
createKeyStore

### Parameters
- **password** (String) - Required - The password to protect the keystore.
- **exportPrivateKey** (boolean) - Required - Whether to export the private key.
- **keyPassword** (char[]) - Required - The password for the private key.

### Return
A `KeyStore` containing the private key and certificate chain.
```

--------------------------------

### forKeyStore(KeyStoreConfiguration)

Source: https://docs.spring.io/spring-vault/docs/current/api/org/springframework/vault/support/SslConfiguration.html

Creates a new SslConfiguration for the given key store configuration.

```APIDOC
## forKeyStore(KeyStoreConfiguration)

### Description
Creates a new `SslConfiguration` for the given `key store`.

### Method
Static factory method

### Signature
`public static SslConfiguration forKeyStore(SslConfiguration.KeyStoreConfiguration keyStore)`

### Parameters
- `keyStore` (SslConfiguration.KeyStoreConfiguration) - Required - Resource pointing to an existing key store, must not be null.

### Returns
The created `SslConfiguration`.

### Since
2.2

### See Also
- `KeyStore`
```

--------------------------------

### GET /sys/policy/

Source: https://docs.spring.io/spring-vault/docs/current/api/org/springframework/vault/core/VaultSysTemplate.html

Lists policy names stored in Vault.

```APIDOC
## GET /sys/policy/

### Description
Lists policy names stored in Vault.

### Method
GET

### Endpoint
/sys/policy/

### Response
#### Success Response (200)
- **List<String>** - A list of policy names.

### See Also
- GET /sys/policy/
```

--------------------------------

### get(String path)

Source: https://docs.spring.io/spring-vault/docs/current/api/org/springframework/vault/core/ReactiveVaultVersionedKeyValueOperations.html

Reads the most recent secret at the given path.

```APIDOC
## get(String path)

### Description
Read the most recent secret at `path`.

### Method
GET

### Parameters
- **path** (String) - Required - The path of the secret.

### Returns
`Mono<Versioned<Map<String,Object>>>` - The most recent secret wrapped in a `Versioned` object.
```

--------------------------------

### SslConfiguration.forTrustStore(Resource, char[])

Source: https://docs.spring.io/spring-vault/docs/current/api/org/springframework/vault/support/SslConfiguration.html

Factory method to create an SslConfiguration with a trust store resource and password.

```APIDOC
## SslConfiguration.forTrustStore(Resource, char[])

### Description
Creates a new `SslConfiguration` for the given trust store with the default `KeyStore` type.

### Method
static factory method

### Signature
`public static SslConfiguration forTrustStore(Resource trustStore, char[] trustStorePassword)`

### Parameters
- **trustStore** (Resource) - Required - The trust store resource.
- **trustStorePassword** (char[]) - Required - The trust store password.

### Returns
A new `SslConfiguration` instance.
```

--------------------------------

### SslConfiguration.KeyStoreConfiguration.unconfigured()

Source: https://docs.spring.io/spring-vault/docs/current/api/org/springframework/vault/support/class-use/SslConfiguration.KeyStoreConfiguration.html

Creates an unconfigured, empty `SslConfiguration.KeyStoreConfiguration`.

```APIDOC
## SslConfiguration.KeyStoreConfiguration.unconfigured()

### Description
Creates an unconfigured, empty `SslConfiguration.KeyStoreConfiguration`.

### Method
static factory method

### Signature
`public static SslConfiguration.KeyStoreConfiguration unconfigured()`

### Returns
- **SslConfiguration.KeyStoreConfiguration** - An unconfigured, empty `SslConfiguration.KeyStoreConfiguration` instance.
```

--------------------------------

### fromSupplier(Supplier<T>)

Source: https://docs.spring.io/spring-vault/docs/current/api/org/springframework/vault/authentication/AuthenticationSteps.html

Starts flow composition from a Supplier, returning the first Node.

```APIDOC
## [STATIC] fromSupplier(Supplier<T>)

### Description
Starts flow composition from a `Supplier`.

### Method
STATIC

### Signature
`public static <T> AuthenticationSteps.Node<T> fromSupplier(Supplier<T> supplier)`

### Parameters
- **supplier** (Supplier<T>) - Required - Supplier function that will produce the flow value, must not be null. Infrastructure components evaluating authentication steps may inspect the given `Supplier` for an optimized approach to obtain its value.

### Returns
- The first `AuthenticationSteps.Node`.
```

--------------------------------

### build()

Source: https://docs.spring.io/spring-vault/docs/current/api/org/springframework/vault/support/VaultTransitKeyConfiguration.VaultTransitKeyConfigurationBuilder.html

Builds a new VaultTransitKeyConfiguration instance.

```APIDOC
## Method: build

### Description
Builds a new VaultTransitKeyConfiguration instance.

### Returns
A new VaultTransitKeyConfiguration.
```

--------------------------------

### fromValue(T)

Source: https://docs.spring.io/spring-vault/docs/current/api/org/springframework/vault/authentication/AuthenticationSteps.html

Starts flow composition from a scalar value, returning the first Node.

```APIDOC
## [STATIC] fromValue(T)

### Description
Starts flow composition from a scalar `value`.

### Method
STATIC

### Signature
`public static <T> AuthenticationSteps.Node<T> fromValue(T value)`

### Parameters
- **value** (T) - Required - The value to be used from this `AuthenticationSteps.Node`, must not be null.

### Returns
- The first `AuthenticationSteps.Node`.

### Since
2.3
```

--------------------------------

### ClientHttpConnectorFactory.JdkHttpClient.getBuilder(ClientOptions, SslConfiguration)

Source: https://docs.spring.io/spring-vault/docs/current/api/org/springframework/vault/support/class-use/SslConfiguration.html

Gets a JDK HttpClient.Builder for the given ClientOptions and SslConfiguration.

```APIDOC
## ClientHttpConnectorFactory.JdkHttpClient.getBuilder(ClientOptions, SslConfiguration)

### Description
Gets a JDK `HttpClient.Builder` for the given `ClientOptions` and `SslConfiguration`.

### Method
static HttpClient.Builder

### Signature
`static HttpClient.Builder getBuilder(ClientOptions options, SslConfiguration sslConfiguration)`

### Parameters
- `options` (ClientOptions) - Required - The client options.
- `sslConfiguration` (SslConfiguration) - Required - The SSL configuration.

### Returns
A JDK `HttpClient.Builder` instance.
```

--------------------------------

### SslConfiguration(SslConfiguration.KeyStoreConfiguration, SslConfiguration.KeyConfiguration, SslConfiguration.KeyStoreConfiguration, List<String>, List<String>)

Source: https://docs.spring.io/spring-vault/docs/current/api/org/springframework/vault/support/SslConfiguration.html

Constructor that creates a new SslConfiguration with key store, key configuration, trust store, enabled protocols, and enabled cipher suites.

```APIDOC
## SslConfiguration(SslConfiguration.KeyStoreConfiguration, SslConfiguration.KeyConfiguration, SslConfiguration.KeyStoreConfiguration, List<String>, List<String>)

### Description
Creates a new `SslConfiguration` with key store, key configuration, trust store, enabled protocols, and enabled cipher suites.

### Method
Constructor

### Signature
`public SslConfiguration(SslConfiguration.KeyStoreConfiguration keyStoreConfiguration, SslConfiguration.KeyConfiguration keyConfiguration, SslConfiguration.KeyStoreConfiguration trustStoreConfiguration, List<String> enabledProtocols, List<String> enabledCipherSuites)`

### Parameters
- `keyStoreConfiguration` (SslConfiguration.KeyStoreConfiguration) - Required - the key store configuration, must not be null.
- `keyConfiguration` (SslConfiguration.KeyConfiguration) - Required - the configuration for a specific key in `keyStoreConfiguration` to use.
- `trustStoreConfiguration` (SslConfiguration.KeyStoreConfiguration) - Required - the trust store configuration, must not be null.
- `enabledProtocols` (List<String>) - Optional - the enabled SSL protocols, elements must match protocol version strings used by the enabled Java SSL provider. May be null to indicate the SSL socket factory should use a default list of enabled protocol versions.
- `enabledCipherSuites` (List<String>) - Optional - the enabled SSL cipher suites, elements must match cipher suite strings used by the enabled Java SSL provider. May be null to indicate the SSL socket factory should use a default list of enabled cipher suites.

### Since
2.3.2
```
Tokens:
Raw