public interface Sys
APIs for Sys operations on Vault.
  • Field Details

    • API

      static final SysApi<Sys> API
      The API of this sys implementation.
  • Method Details

    • enableEngine

      default EnableEngine.Response enableEngine(Engine<?> engine)
      Enable (mount) a secret engine on a default path.
      Parameters:
      engine - engine to enable
      Returns:
      when the engine is enabled
    • enableEngine

      Enable (mount) a secret engine with custom configuration.
      Parameters:
      request - request for mount operation
      Returns:
      when the engine is enabled
    • disableEngine

      default DisableEngine.Response disableEngine(Engine<?> engine)
      Disable (unmount) a secret engine from default path.
      Parameters:
      engine - to disable
      Returns:
      when the engine is disabled
    • disableEngine

      default DisableEngine.Response disableEngine(String path)
      Disable (unmount) a secret engine from specific path.
      Parameters:
      path - mount path
      Returns:
      when the engine is disabled
    • disableEngine

      Disable (unmount) a secrets engine.
      Parameters:
      request - disable engine request
      Returns:
      disable engine response
    • enableAuth

      default EnableAuth.Response enableAuth(AuthMethod<?> authMethod)
      Enable an authentication method on default path.
      Parameters:
      authMethod - authentication method to enable
      Returns:
      when the method is enabled
    • enableAuth

      Enable an authentication method on custom path or with additional configuration.
      Parameters:
      request - mount request
      Returns:
      when the method is enabled
    • disableAuth

      default DisableAuth.Response disableAuth(String path)
      Disable an authentication method.
      Parameters:
      path - path of the method
      Returns:
      when method is disabled
    • disableAuth

      Disable an authentication method.
      Parameters:
      request - disable authentication method request
      Returns:
      disable authentication method response
    • createPolicy

      default CreatePolicy.Response createPolicy(String name, String policy)
      Create a policy.
      Parameters:
      name - name of the policy
      policy - policy document
      Returns:
      when policy is created
    • createPolicy

      Create a policy.
      Parameters:
      request - create a policy request
      Returns:
      create policy response
    • deletePolicy

      default DeletePolicy.Response deletePolicy(String name)
      Delete a policy.
      Parameters:
      name - name of the policy
      Returns:
      when policy is deleted
    • deletePolicy

      Delete a policy.
      Parameters:
      request - delete policy request
      Returns:
      delete policy response