Show API reference for
star

Tip

Learn more in User authentication and information.

st.logout

Logout the current user.

This command removes the user's information from st.user and deletes their Streamlit identity cookie. If the OpenID Connect (OIDC) provider's server metadata includes end_session_endpoint, this command also redirects the user to perform a logout from the identity provider before returning to your app. Otherwise, it only performs a local logout from your app. This creates a new session.

If the user has multiple sessions open in the same browser, st.user will not be cleared in any other session. st.user only reads from the identity cookie at the start of a session. After a session is running, you must call st.login() or st.logout() within that session to update st.user.

Function signature[source]

st.logout()

Example

.streamlit/secrets.toml:

Python
[auth]
redirect_uri = "http://localhost:8501/oauth2callback"
cookie_secret = "xxx"
client_id = "xxx"
client_secret = "xxx"
server_metadata_url = "https://accounts.google.com/.well-known/openid-configuration"  # fmt: skip

Your app code:

Python
import streamlit as st

if not st.user.is_logged_in:
    if st.button("Log in"):
        st.login()
else:
    if st.button("Log out"):
        st.logout()
    st.write(f"Hello, {st.user.name}!")
arrow_backPrevious: st.loginarrow_forwardNext: st.user
forum

Still have questions?

Our forums are full of helpful information and Streamlit experts.