Skip to main content

logoutUser()

This page provides information about the logoutUser() function, which allows users to implement custom logout functionality and specify redirection behavior after logging out.

logoutUser()
logoutUser()

Signature​

logoutUser(redirectUrl?: string): void

Parameters​

Below are the parameters required by the logoutUser() function to execute:

redirectUrl string​

Specifies the URL where the user should be redirected after logging out. If not provided, the user is redirected to /user/login, with the default redirection set to the current page.

Usage​

Here are a few examples of using logoutUser() in different situations:

Logout and redirect to current page​

Logs out the user and redirects them back to the same page after login. This is useful when users should return to their previous location without needing a manual redirect.

logoutUser();

Logout and redirect to same page​

Ensures that users always return to the exact page they logged out from by explicitly setting the redirect URL to the current page.

logoutUser(appsmith.URL.pathname);

This redirects the user to /user/login?redirectUrl=<current_path>, allowing them to resume from where they left off.

Logout and redirect to custom page​

Logs out the user and redirects them to a predefined page, such as a dashboard or a specific section of the application.

logoutUser("/app/abc");

This directs the user to /user/login?redirectUrl=/app/abc, ensuring that after login, they land on the specified page instead of the default applications page.