Supabase.Auth.Admin.OAuth.Behaviour behaviour (supabase_auth v1.0.1)

Behaviour for admin-level OAuth 2.1 client management operations.

Defines the contract for managing OAuth clients programmatically via the GoTrue admin API. Requires a service_role key.

Summary

pagination()

get_client(t, t)

@type pagination() :: %{
  next_page: integer() | nil,
  last_page: integer(),
  total: integer()
}

@callback create_client(Supabase.Client.t(), map()) ::
  {:ok, Supabase.Auth.Schemas.OAuth.AdminClient.t()} | {:error, term()}

@callback delete_client(Supabase.Client.t(), String.t()) :: :ok | {:error, term()}

@callback get_client(Supabase.Client.t(), String.t()) ::
  {:ok, Supabase.Auth.Schemas.OAuth.AdminClient.t()} | {:error, term()}

@callback list_clients(Supabase.Client.t(), map()) ::
  {:ok, [Supabase.Auth.Schemas.OAuth.AdminClient.t()], pagination()}
  | {:error, term()}

@callback regenerate_client_secret(Supabase.Client.t(), String.t()) ::
  {:ok, Supabase.Auth.Schemas.OAuth.AdminClient.t()} | {:error, term()}

@callback update_client(Supabase.Client.t(), String.t(), map()) ::
  {:ok, Supabase.Auth.Schemas.OAuth.AdminClient.t()} | {:error, term()}