Package pl.edu.icm.unity.engine.api

Interface AuthenticationFlowManagement

  • public interface AuthenticationFlowManagement
    API for authentication flow management.
    Author:
    P.Piernik

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      void addAuthenticationFlow​(pl.edu.icm.unity.types.authn.AuthenticationFlowDefinition authenticatorsFlowDefinition)
      Add new authentication flow
      pl.edu.icm.unity.types.authn.AuthenticationFlowDefinition getAuthenticationFlow​(java.lang.String name)
      Get authentication flow by given name
      java.util.Collection<pl.edu.icm.unity.types.authn.AuthenticationFlowDefinition> getAuthenticationFlows()  
      boolean getUserMFAOptIn​(long entityId)
      Get user multifactor optin attribute
      void removeAuthenticationFlow​(java.lang.String toRemove)
      Removes an existing authentication flow.
      void setUserMFAOptIn​(long entityId, boolean value)
      Set user multifactor optin attribute
      void updateAuthenticationFlow​(pl.edu.icm.unity.types.authn.AuthenticationFlowDefinition authFlowdef)
      Update existing authentication flow

    • Method Detail

      • addAuthenticationFlow

        void addAuthenticationFlow​(pl.edu.icm.unity.types.authn.AuthenticationFlowDefinition authenticatorsFlowDefinition)
                    throws pl.edu.icm.unity.exceptions.EngineException
        Add new authentication flow
        Parameters:
        authenticatorsFlowDefinition -
        Throws:
        pl.edu.icm.unity.exceptions.AuthorizationException
        pl.edu.icm.unity.exceptions.EngineException

      • removeAuthenticationFlow

        void removeAuthenticationFlow​(java.lang.String toRemove)
                       throws pl.edu.icm.unity.exceptions.EngineException
        Removes an existing authentication flow. The authentication flow must not be used by any of the endpoints, to be removed.
        Parameters:
        toRemove - authentication flow id
        Throws:
        pl.edu.icm.unity.exceptions.AuthorizationException
        pl.edu.icm.unity.exceptions.EngineException

      • getAuthenticationFlows

        java.util.Collection<pl.edu.icm.unity.types.authn.AuthenticationFlowDefinition> getAuthenticationFlows()
                                                                                                throws pl.edu.icm.unity.exceptions.EngineException
        Returns:
        list of currently configured authentication flow
        Throws:
        pl.edu.icm.unity.exceptions.EngineException

      • getAuthenticationFlow

        pl.edu.icm.unity.types.authn.AuthenticationFlowDefinition getAuthenticationFlow​(java.lang.String name)
                                                                         throws pl.edu.icm.unity.exceptions.EngineException
        Get authentication flow by given name
        Returns:
        authentication flow
        Throws:
        pl.edu.icm.unity.exceptions.EngineException

      • updateAuthenticationFlow

        void updateAuthenticationFlow​(pl.edu.icm.unity.types.authn.AuthenticationFlowDefinition authFlowdef)
                       throws pl.edu.icm.unity.exceptions.EngineException
        Update existing authentication flow
        Parameters:
        authFlowdef -
        Throws:
        pl.edu.icm.unity.exceptions.EngineException

      • getUserMFAOptIn

        boolean getUserMFAOptIn​(long entityId)
                 throws pl.edu.icm.unity.exceptions.EngineException
        Get user multifactor optin attribute
        Parameters:
        entityId -
        Returns:
        Throws:
        pl.edu.icm.unity.exceptions.EngineException

      • setUserMFAOptIn

        void setUserMFAOptIn​(long entityId,
                     boolean value)
              throws pl.edu.icm.unity.exceptions.EngineException
        Set user multifactor optin attribute
        Parameters:
        entityId -
        value -
        Throws:
        pl.edu.icm.unity.exceptions.EngineException