mirror of
https://github.com/supabase/supabase.git
synced 2026-07-03 07:14:27 +08:00
60 lines
1.4 KiB
Plaintext
60 lines
1.4 KiB
Plaintext
---
|
|
id: auth-api-getuser
|
|
title: 'getUser()'
|
|
slug: auth-api-getuser
|
|
custom_edit_url: https://github.com/supabase/supabase/edit/master/spec/supabase_js_v1_legacy.yml
|
|
---
|
|
|
|
import Tabs from '@theme/Tabs'
|
|
import TabItem from '@theme/TabItem'
|
|
|
|
Gets the current user details.
|
|
|
|
This method is called by the GoTrueClient `update` where
|
|
the jwt is set to this.currentSession.access_token
|
|
and therefore, acts like getting the currently authenticated user
|
|
|
|
```js
|
|
const { user, error } = await supabase.auth.api.getUser('ACCESS_TOKEN_JWT')
|
|
```
|
|
|
|
## Parameters
|
|
|
|
<ul className="method-list-group">
|
|
|
|
<li className="method-list-item">
|
|
<h4 className="method-list-item-label">
|
|
<span className="method-list-item-label-name">
|
|
jwt
|
|
</span>
|
|
<span className="method-list-item-label-badge required">
|
|
required
|
|
</span>
|
|
<span className="method-list-item-validation">
|
|
<code>string</code>
|
|
</span>
|
|
</h4>
|
|
<div class="method-list-item-description">
|
|
|
|
A valid, logged-in JWT. Typically, the access_token for the currentSession
|
|
|
|
</div>
|
|
|
|
</li>
|
|
|
|
</ul>
|
|
|
|
## Notes
|
|
|
|
- Fetches the user object from the database instead of local storage.
|
|
- Note that user() fetches the user object from local storage which might not be the most updated.
|
|
- Requires the user's access_token.
|
|
|
|
## Examples
|
|
|
|
### Fetch the user object using the access_token jwt.
|
|
|
|
```js
|
|
const { user, error } = await supabase.auth.api.getUser('ACCESS_TOKEN_JWT')
|
|
```
|