JavaScript: Get user claims from verified JWT (original) (raw)

• Introduction
• Installing
• Initializing
• TypeScript support
• Database
• Fetch data
• Insert data
• Update data
• Upsert data
• Delete data
• Call a Postgres function
• Using filters
• Column is equal to a value
• Column is not equal to a value
• Column is greater than a value
• Column is greater than or equal to a value
• Column is less than a value
• Column is less than or equal to a value
• Column matches a pattern
• Column matches a case-insensitive pattern
• Column is a value
• Column is in an array
• Column contains every element in a value
• Contained by value
• Greater than a range
• Greater than or equal to a range
• Less than a range
• Less than or equal to a range
• Mutually exclusive to a range
• With a common element
• Match a string
• Match an associated value
• Don't match the filter
• Match at least one filter
• Match the filter
• Using modifiers
• Return data after inserting
• Order the results
• Limit the number of rows returned
• Limit the query to a range
• Set an abort signal
• Retrieve one row of data
• Retrieve zero or one row of data
• Retrieve as a CSV
• Override type of successful response
• Partially override or replace type of successful response
• Using explain
• Auth
• Overview
• Create a new user
• Listen to auth events
• Create an anonymous user
• Sign in a user
• Sign in with ID token (native sign-in)
• Sign in a user through OTP
• Sign in a user through OAuth
• Sign in a user through SSO
• Sign in a user through Web3 (Solana, Ethereum)
• Get user claims from verified JWT
• Sign out a user
• Send a password reset request
• Verify and log in through OTP
• Retrieve a session
• Retrieve a new session
• Retrieve a user
• Update a user
• Retrieve identities linked to a user
• Link an identity to a user
• Unlink an identity from a user
• Send a password reauthentication nonce
• Resend an OTP
• Set the session data
• Exchange an auth code for a session
• Start auto-refresh session (non-browser)
• Stop auto-refresh session (non-browser)
• Initialize client session
• Auth MFA
• Enroll a factor
• Create a challenge
• Verify a challenge
• Create and verify a challenge
• Unenroll a factor
• Get Authenticator Assurance Level
• List all factors for current user
• OAuth Server
• Get authorization details
• Approve authorization
• Deny authorization
• List grants
• Revoke grant
• Auth Admin
• Retrieve a user
• List all users
• Create a user
• Delete a user
• Send an email invite link
• Generate an email link
• Update a user
• Sign out a user (admin)
• Delete a factor for a user
• List all factors for a user (admin)
• OAuth Admin
• List OAuth clients
• Get OAuth client
• Create OAuth client
• Update OAuth client
• Delete OAuth client
• Regenerate client secret
• Edge Functions
• Invokes a Supabase Edge Function.
• Realtime
• Subscribe to channel
• Unsubscribe from a channel
• Unsubscribe from all channels
• Retrieve all channels
• Broadcast a message
• Storage
• File Buckets
• Access a storage bucket
• List all buckets
• Retrieve a bucket
• Create a bucket
• Empty a bucket
• Update a bucket
• Delete a bucket
• Upload a file
• Replace an existing file
• Move an existing file
• Copy an existing file
• Create a signed URL
• Create signed URLs
• Create signed upload URL
• Upload to a signed URL
• Retrieve public URL
• Download a file
• Delete files in a bucket
• List all files in a bucket
• Check if file exists
• Get file metadata
• List files (v2)
• Convert file to base64
• Analytics Buckets
• Access an analytics bucket
• Create a new analytics bucket
• List analytics buckets
• Delete an analytics bucket
• Vector Buckets
• Access a vector bucket
• Create a vector bucket
• Delete a vector bucket
• Retrieve a vector bucket
• List all vector buckets
• Create a vector index
• Delete a vector index
• Retrieve a vector index
• List all vector indexes
• Access a vector index
• Delete vectors from index
• Retrieve vectors from index
• List vectors in index
• Add vectors to index
• Search vectors in index

Extracts the JWT claims present in the access token by first verifying the JWT against the server's JSON Web Key Set endpoint /.well-known/jwks.json which is often cached, resulting in significantly faster responses. Prefer this method over #getUser which always sends a request to the Auth server for each JWT.

If the project is not using an asymmetric JWT signing key (like ECC or RSA) it always sends a request to the Auth server (similar to #getUser) to verify the JWT.

• Parses the user's access token as a JSON Web Token (JWT) and returns its components if valid and not expired.
• If your project is using asymmetric JWT signing keys, then the verification is done locally usually without a network request using the WebCrypto API.
• A network request is sent to your project's JWT signing key discovery endpoint https://project-id.supabase.co/auth/v1/.well-known/jwks.json, which is cached locally. If your environment is ephemeral, such as a Lambda function that is destroyed after every request, a network request will be sent for each new invocation. Supabase provides a network-edge cache providing fast responses for these situations.
• If the user's access token is about to expire when calling this function, the user's session will first be refreshed before validating the JWT.
• If your project is using a symmetric secret to sign the JWT, it always sends a request similar to getUser() to validate the JWT at the server before returning the decoded token. This is also used if the WebCrypto API is not available in the environment. Make sure you polyfill it in such situations.
• The returned claims can be customized per project using the Custom Access Token Hook.

Parameters

• jwt

(Optional)
An optional specific JWT you wish to verify, not the one you can obtain from #getSession.

• options

(Required)
Various additional options that allow you to customize the behavior of this method.

Examples

Get JWT claims, header and signature

const { data, error } = await supabase.auth.getClaims()