API Reference supabase_auth v#1.0.1

View Source

Modules

The main interface for interacting with Supabase's Auth authentication service. This module provides comprehensive functionality for user authentication, session management, and identity handling in Elixir applications.

Admin module for Auth. This module provides functions to interact with the Auth admin API, like signing out a user, inviting a user, and generating a link.

Fixtures for Admin custom provider testing.

Admin custom OIDC/OAuth provider management for Supabase Auth.

Behaviour for admin-level custom OIDC/OAuth provider management.

This module is used to generate a link fixture for testing.

Admin OAuth 2.1 client management for Supabase Auth.

Behaviour for admin-level OAuth 2.1 client management operations.

Fixtures for Admin OAuth client testing.

This module is used to generate a user fixture for testing admin APIs.

Behaviour specification for the Supabase.Auth.Admin module.

Behaviour specification for the Supabase.Auth module.

This module is used to generate fixtures for the Supabase.Error schema.

This module provides JWT fixtures for testing.

Provides LiveView integrations for the Supabase Auth authentication in Elixir applications.

Multi-Factor Authentication (MFA) operations for Supabase Auth.

Behaviour for MFA operations with type definitions.

This module is used to generate fixtures for MFA-related data.

OAuth 2.1 authorization server APIs for grant management and consent flows.

Behaviour defining OAuth 2.1 authorization server user-facing operations.

Fixtures for OAuth testing.

This module is used to generate PKCE (Proof Key for Code Exchange) values.

Provides Plug-based authentication support for the Supabase Auth authentication in Elixir applications.

A body decoder that transforms empty response to a valid map.

Schema for custom OAuth/OIDC provider returned from the admin API.

Schema for OAuth client representation in admin operations.

Schema for OAuth authorization request details using schemaless changesets.

Schema for OAuth client representation using schemaless changesets.

Schema for OAuth consent response using schemaless changesets.

Schema for OAuth grant representation using schemaless changesets.

Parameters for resending confirmation or verification emails/SMS.

Represents the health information of the Auth authentication server.

Represents the configuration settings of the Auth authentication server.

Parameters for anonymous sign-in.

Parameters for updating user profiles.

Server health fixture for Auth. This module provides functions to generate server health fixtures.

Server settings fixture for Auth. This module provides functions to generate server settings fixtures.

Represents an authenticated session with Supabase's Auth service.

This module is used to generate a session fixture for testing.

Custom Ecto type for OAuth provider validation.

Represents a user profile in the Supabase authentication system.

This schema is used to validate and parse the parameters for a user factor.

This schema is used to validate and parse the identity of a user.

This module is used to generate fixtures for the Supabase.Auth.User schema.

Helpers for working with weak password errors from GoTrue.

Fixtures for weak password error responses from GoTrue.

Supabase.GoTrue deprecated

Mix Tasks

Generates authentication logic backed by Supabase and related views for Phoenix.