Auth0
source: documentation: author: supabase tags:
- native
- official
Auth0
Auth0 is a flexible, drop-in solution to add authentication and authorization services to your applications
The Auth0 Wrapper allows you to read data from your Auth0 tenant for use within your Postgres database.
Restoring a logical backup of a database with a materialized view using a foreign table can fail. For this reason, either do not use foreign tables in materialized views or use them in databases with physical backups enabled.
Preparation
Before you get started, make sure the wrappers
extension is installed on your database:
_10create extension if not exists wrappers with schema extensions;
and then create the foreign data wrapper:
_10create foreign data wrapper auth0_wrapper_10 handler auth0_fdw_handler_10 validator auth0_fdw_validator;
Secure your credentials (optional)
By default, Postgres stores FDW credentials inide pg_catalog.pg_foreign_server
in plain text. Anyone with access to this table will be able to view these credentials. Wrappers is designed to work with Vault, which provides an additional level of security for storing credentials. We recommend using Vault to store your credentials.
_10-- Save your Auth0 API key in Vault and retrieve the `key_id`_10insert into vault.secrets (name, secret)_10values (_10 'auth0',_10 '<Auth0 API Key or PAT>' -- Auth0 API key or Personal Access Token (PAT)_10)_10returning key_id;
Connecting to Auth0
We need to provide Postgres with the credentials to connect to Airtable, and any additional options. We can do this using the create server
command:
_10create server auth0_server_10 foreign data wrapper auth0_wrapper_10 options (_10 api_key_id '<key_ID>' -- The Key ID from above._10 );
Creating Foreign Tables
The Auth0 Wrapper supports data reads from Auth0's Management API List users endpoint endpoint (read only).
Auth0 | Select | Insert | Update | Delete | Truncate |
---|---|---|---|---|---|
Records | ✅ | ❌ | ❌ | ❌ | ❌ |
For example:
_10create foreign table my_foreign_table (_10 name text_10 -- other fields_10)_10server auth0_server_10options (_10 object 'users',_10);
Foreign table options
The full list of foreign table options are below:
objects
- Auth0 object to select from. Currently only supportsusers
Query Pushdown Support
This FDW doesn't support query pushdown.
Examples
Some examples on how to use Auth0 foreign tables.
Basic example
This will create a "foreign table" inside your Postgres database called auth0_table
:
_10create foreign table auth0_table (_10 created_at text,_10 email text,_10 email_verified bool,_10 identities jsonb_10)_10 server auth0_server_10 options (_10 object 'users'_10 );
You can now fetch your Auth0 data from within your Postgres database:
_10select * from auth0;