Documentation home pagelight logodark logo
  • Support
  • Dashboard
  • Dashboard
Auth
signOut()
Documentation
Reference
Guides
  • Documentation
  • Documentation
  • Community
  • Blog
  • API Documentation
    • Overview
    Backend Services
    • Authentication
    • Storage
    GraphQL
    • AI
    Client Libraries
    • JavaScript
      • Auth
        • HasuraAuthClient
        • changeEmail()
        • changePassword()
        • createPAT()
        • getAccessToken()
        • getAuthenticationStatus()
        • getDecodedAccessToken()
        • getHasuraClaim()
        • getHasuraClaims()
        • getSession()
        • getUser()
        • isAuthenticated()
        • isAuthenticatedAsync()
        • onAuthStateChanged()
        • onTokenChanged()
        • refreshSession()
        • resetPassword()
        • sendVerificationEmail()
        • signIn()
        • signInPAT()
        • signOut()
        • signUp()
        • addSecurityKey()
        • elevateEmailSecurityKey()
        • connectProvider()
      • Storage
      • GraphQL
      • Functions
    • React
    • Next.js
    • Vue
    Auth

    signOut()

    Use nhost.auth.signOut to sign out the user.

    nhost.auth.signOut()
    

    ​
    Parameters


    params optional { all: boolean }


    ​
    Examples

    ​
    Sign out the user from current device

    nhost.auth.signOut()
    

    ​
    Sign out the user from all devices

    nhost.auth.signOut({ all: true })
    
    signInPAT()signUp()
    twittergithublinkedin
    Powered by Mintlify
    On this page
    • Parameters
    • Examples
    • Sign out the user from current device
    • Sign out the user from all devices