Interface ExternalLogoutProvider

public interface ExternalLogoutProvider

Interface for custom external logouts which are performed through the frontend API when logging out the current user.

Method Summary

Modifier and Type	Method	Description
org.springframework.http.ResponseEntity<Object>	retrieveExternalLogout(org.springframework.security.core.Authentication authentication, jakarta.servlet.http.HttpServletRequest request)	Retrieves a logout object on which the user can use to log out from the external system

Method Details

retrieveExternalLogout

org.springframework.http.ResponseEntity<Object> retrieveExternalLogout(org.springframework.security.core.Authentication authentication,
 jakarta.servlet.http.HttpServletRequest request)
                                                                throws Exception

Retrieves a logout object on which the user can use to log out from the external system

Parameters:

authentication - the current Authentication object

request - the current HTTP request

Returns:

response for the current HTTP request

Throws:

Exception - implementations can throw any exception when they fail to retrieve a logout object