mirror of
https://github.com/supabase/supabase.git
synced 2026-10-11 20:35:07 +03:00
Chris ChinchillaandCharis Lam
6821c07811
* Docs feature toggle tests * Prettier * Types fix * Hide unsupported languages * Fix import * Add unsupported code warning * Further SDK toggling * Temp intro text * Auth toggles * clean up conditional visibility code * fix: typecheck, tests, tiny bug --------- Co-authored-by: Charis Lam <26616127+charislam@users.noreply.github.com>
145 lines
3.1 KiB
Plaintext
145 lines
3.1 KiB
Plaintext
---
|
|
title: 'Signing out'
|
|
subtitle: 'Signing out a user'
|
|
---
|
|
|
|
Signing out a user works the same way no matter what method they used to sign in.
|
|
|
|
Call the sign out method from the client library. It removes the active session and clears Auth data from the storage medium.
|
|
|
|
<Tabs
|
|
scrollable
|
|
size="small"
|
|
type="underlined"
|
|
defaultActiveId="js"
|
|
queryGroup="language"
|
|
>
|
|
<TabPanel id="js" label="JavaScript">
|
|
|
|
```js
|
|
import { createClient } from '@supabase/supabase-js'
|
|
const supabase = createClient(
|
|
'https://your-project-id.supabase.co',
|
|
'sb_publishable_... or anon key'
|
|
)
|
|
|
|
// ---cut---
|
|
async function signOut() {
|
|
const { error } = await supabase.auth.signOut()
|
|
}
|
|
```
|
|
|
|
</TabPanel>
|
|
<$Show if="sdk:dart">
|
|
<TabPanel id="dart" label="Dart">
|
|
|
|
```dart
|
|
Future<void> signOut() async {
|
|
await supabase.auth.signOut();
|
|
}
|
|
```
|
|
|
|
</TabPanel>
|
|
</$Show>
|
|
<$Show if="sdk:swift">
|
|
<TabPanel id="swift" label="Swift">
|
|
|
|
```swift
|
|
try await supabase.auth.signOut()
|
|
```
|
|
|
|
</TabPanel>
|
|
</$Show>
|
|
<$Show if="sdk:kotlin">
|
|
<TabPanel id="kotlin" label="Kotlin">
|
|
|
|
```kotlin
|
|
suspend fun logout() {
|
|
supabase.auth.signOut()
|
|
}
|
|
```
|
|
|
|
</TabPanel>
|
|
</$Show>
|
|
<$Show if="sdk:python">
|
|
<TabPanel id="python" label="Python">
|
|
|
|
```python
|
|
supabase.auth.sign_out()
|
|
```
|
|
|
|
</TabPanel>
|
|
</$Show>
|
|
</Tabs>
|
|
|
|
## Sign out and scopes
|
|
|
|
Supabase Auth allows you to specify three different scopes for when a user invokes the [sign out API](/docs/reference/javascript/auth-signout) in your application:
|
|
|
|
- `global` (default) when all sessions active for the user are terminated.
|
|
- `local` which only terminates the current session for the user but keep sessions on other devices or browsers active.
|
|
- `others` to terminate all but the current session for the user.
|
|
|
|
You can invoke these by providing the `scope` option:
|
|
|
|
<Tabs
|
|
scrollable
|
|
size="small"
|
|
type="underlined"
|
|
defaultActiveId="js"
|
|
queryGroup="language"
|
|
>
|
|
<TabPanel id="js" label="JavaScript">
|
|
|
|
```js
|
|
import { createClient } from '@supabase/supabase-js'
|
|
const supabase = createClient(
|
|
'https://your-project-id.supabase.co',
|
|
'sb_publishable_... or anon key'
|
|
)
|
|
|
|
// ---cut---
|
|
// defaults to the global scope
|
|
await supabase.auth.signOut()
|
|
|
|
// sign out from the current session only
|
|
await supabase.auth.signOut({ scope: 'local' })
|
|
```
|
|
|
|
</TabPanel>
|
|
<$Show if="sdk:dart">
|
|
<TabPanel id="dart" label="Dart">
|
|
|
|
```dart
|
|
// defaults to the local scope
|
|
await supabase.auth.signOut();
|
|
|
|
// sign out from all sessions
|
|
await supabase.auth.signOut(scope: SignOutScope.global);
|
|
```
|
|
|
|
</TabPanel>
|
|
</$Show>
|
|
<$Show if="sdk:kotlin">
|
|
<TabPanel id="kotlin" label="Kotlin">
|
|
|
|
```kotlin
|
|
// defaults to the local scope
|
|
await supabase.auth.signOut();
|
|
|
|
// sign out from all sessions
|
|
supabase.auth.signOut(SignOutScope.GLOBAL)
|
|
```
|
|
|
|
</TabPanel>
|
|
</$Show>
|
|
</Tabs>
|
|
|
|
Upon sign out, all refresh tokens and potentially other database objects related to the affected sessions are destroyed and the client library removes the session stored in the local storage medium.
|
|
|
|
<Admonition type="caution">
|
|
|
|
Access Tokens of revoked sessions remain valid until their expiry time, encoded in the `exp` claim. The user won't be immediately logged out and will only be logged out when the Access Token expires.
|
|
|
|
</Admonition>
|