Package io.datarouter.auth.service.deprovisioning

Interface UserDeprovisioningStrategy

All Known Implementing Classes:
DatarouterUserDeprovisioningStrategy
public interface UserDeprovisioningStrategy
these methods are intended to be called by UserDeprovisioningService in conjunction with UserDeprovisioningListener. See UserDeprovisioningService for exact order and configuration.

  • Method Summary

    Modifier and Type Method Description
    java.util.List<java.lang.String> deprovisionUsers​(java.util.List<java.lang.String> usernames, java.util.Optional<java.lang.String> editorUsername)
    for each username, removes all permissions, deletes or invalidates all sessions, and sets the user to disabled.
    java.util.List<java.lang.String> flagUsers​(java.util.List<java.lang.String> usernames, java.util.Optional<java.lang.String> editorUsername)
    flag users for later manual deprovisioning.
    java.util.List<java.lang.String> restoreUsers​(java.util.List<java.lang.String> usernames, java.util.Optional<java.lang.String> editorUsername)
    restores previously deprovisioned users.

  • Method Details

    • flagUsers

      java.util.List<java.lang.String> flagUsers​(java.util.List<java.lang.String> usernames, java.util.Optional<java.lang.String> editorUsername)
      flag users for later manual deprovisioning. should be fault tolerant for usernames that do not exist.
      Parameters:
      usernames - to flag
      editorUsername - (if manually triggered)
      Returns:
      returns the successfully flagged usernames

    • deprovisionUsers

      java.util.List<java.lang.String> deprovisionUsers​(java.util.List<java.lang.String> usernames, java.util.Optional<java.lang.String> editorUsername)
      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 - to deprovision
      editorUsername - (if manually triggered)
      Returns:
      returns the successfully deprovisioned usernames

    • restoreUsers

      java.util.List<java.lang.String> restoreUsers​(java.util.List<java.lang.String> usernames, java.util.Optional<java.lang.String> editorUsername)
      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, Optional)
      editorUsername - (if manually triggered)
      Returns:
      returns the successfully restored usernames