Interface SysRx

    • Field Detail

      • API

        static final SysApi<SysRx> API
        The API of this sys implementation.
    • Method Detail

      • enableEngine

        default Single<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

        Single<EnableEngine.Response> enableEngine​(EnableEngine.Request request)
        Enable (mount) a secret engine with custom configuration.
        Parameters:
        request - request for mount operation
        Returns:
        when the engine is enabled
      • disableEngine

        default Single<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 Single<DisableEngine.Response> disableEngine​(String path)
        Disable (unmount) a secrets engine from specific path.
        Parameters:
        path - mount path
        Returns:
        when the engine is disabled
      • enableAuth

        default Single<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

        Single<EnableAuth.Response> enableAuth​(EnableAuth.Request request)
        Enable an authentication method on custom path or with additional configuration.
        Parameters:
        request - mount request
        Returns:
        when the method is enabled
      • disableAuth

        default Single<DisableAuth.Response> disableAuth​(String path)
        Disable an authentication method.
        Parameters:
        path - path of the method
        Returns:
        disable authentication method response
      • disableAuth

        Single<DisableAuth.Response> disableAuth​(DisableAuth.Request request)
        Disable an authentication method.
        Parameters:
        request - disable authentication method request
        Returns:
        disable authentication method response
      • createPolicy

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

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