Zuvo Docs

Guide

Auth0

Use Auth0 with your Zuvo project

Auth0 can be used as a third-party authentication provider alongside Zuvo Auth, or standalone, with your Zuvo project.

Getting started

  1. First you need to add an integration to connect your Zuvo project with your Auth0 tenant. You will need your tenant ID (and in some cases region ID).
  2. Add a new Third-party Auth integration in your project's Authentication settings.
  3. Assign the role: 'authenticated' custom claim to all JWTs by using an Auth0 Action.
  4. Finally setup the Zuvo client in your application.

Setup the Zuvo client library

TypeScript
import { createClient } from '@supabase/supabase-js'
import { createAuth0Client } from '@auth0/auth0-spa-js'

const auth0 = await createAuth0Client({
  domain: '<AUTH0_DOMAIN>',
  clientId: '<AUTH0_CLIENT_ID>',
  authorizationParams: {
    redirect_uri: '<MY_CALLBACK_URL>',
  },
})

const supabase = createClient(
  'https://<supabase-project>.supabase.co',
  'SUPABASE_PUBLISHABLE_KEY',
  {
    accessToken: async () => {
      // Use the ID token which reliably includes custom claims.
      const idToken = (await auth0.getIdTokenClaims())?.__raw
      if (!idToken) throw new Error('Missing ID token')
      return idToken
    },
  }
)

Add a new Third-Party Auth integration to your project

In the dashboard navigate to your project's Authentication settings and find the Third-Party Auth section to add a new integration.

In the CLI add the following config to your supabase/config.toml file:

[auth.third_party.auth0]
enabled = true
tenant = "<id>"
tenant_region = "<region>" # if your tenant has a region

Use an Auth0 Action to assign the authenticated role

Your Zuvo project inspects the role claim present in all JWTs sent to it, to assign the correct Postgres role when using the Data API, Storage or Realtime authorization.

By default, Auth0 JWTs (both access token and ID token) do not contain a role claim in them. If you were to send such a JWT to your Zuvo project, the anon role would be assigned when executing the Postgres query. Most of your app's logic will be accessible by the authenticated role.

Configure the onExecutePostLogin Auth0 Action to add the custom claim to ID tokens:

exports.onExecutePostLogin = async (event, api) => {
  api.idToken.setCustomClaim('role', 'authenticated')
}

Limitations

At this time, Auth0 tenants with the following signing algorithms are not supported:

  • HS256 (HMAC with SHA-256) -- also known as symmetric JWTs
  • PS256 (RSA-PSS with SHA-256)