Package io.datarouter.auth.service

Interface UserDeprovisioningService

All Known Implementing Classes:
DatarouterUserDeprovisioningService, UserDeprovisioningService.NoOpUserDeprovisioningService
public interface UserDeprovisioningService

  • Nested Class Summary

    Nested Classes 
    Modifier and Type Interface Description
    static class  UserDeprovisioningService.NoOpUserDeprovisioningService  

  • Method Summary

    Modifier and Type Method Description
    void deprovisionUsers​(java.util.List<java.lang.String> usernames)
    for each username, removes all permissions, deletes or invalidates all sessions, and sets the user to disabled.
    java.util.List<java.lang.String> restoreDeprovisionedUsers​(java.util.List<java.lang.String> usernames)
    restores previously deprovisioned users.

  • Method Details

    • deprovisionUsers

      void deprovisionUsers​(java.util.List<java.lang.String> usernames)
      for each username, removes all permissions, deletes or invalidates all sessions, and sets the user to disabled. should be fault tolerant for usernames that do not exist.
      Parameters:
      usernames - usernames to deprovision

    • restoreDeprovisionedUsers

      java.util.List<java.lang.String> restoreDeprovisionedUsers​(java.util.List<java.lang.String> usernames)
      restores previously deprovisioned users. should be fault tolerant for usernames that do not exist or are not in a restorable state.
      Parameters:
      usernames - to restore, which were previously deprovisioned using deprovisionUsers(List)
      Returns:
      returns the successfully restored usernames