Module

x/live/deps.ts>supabase.GoTrueAdminApi

Open-Source web editor based on Preact, Tailwind and TypeScript. The other side of code.
deco-cx/deco
Go to Latest
class supabase.GoTrueAdminApi
import { supabase } from "https://dotland.deno.dev/x/live@1.63.12/deps.ts";
const { GoTrueAdminApi } = supabase;

Constructors

new
GoTrueAdminApi(unnamed 0: { url: string; headers?: { [key: string]: string; }; fetch?: Fetch; })

Properties

private
_deleteFactor
private
_listFactors
protected
fetch: Fetch
protected
headers: { [key: string]: string; }
protected
url: string
mfa: GoTrueAdminMFAApi

Contains all MFA administration methods.

Methods

createUser(attributes: AdminUserAttributes): Promise<UserResponse>

Creates a new user. This function should only be called on a server. Never expose your service_role key in the browser.

deleteUser(id: string, shouldSoftDelete?: boolean): Promise<UserResponse>

Delete a user. Requires a service_role key.

getUserById(uid: string): Promise<UserResponse>

Get user by id.

inviteUserByEmail(email: string, options?: { data?: object; redirectTo?: string; }): Promise<UserResponse>

Sends an invite link to an email address.

listUsers(params?: PageParams): Promise<{ data: { users: User[]; aud: string; } & Pagination; error: null; } | { data: { users: []; }; error: AuthError; }>

Get a list of users.

This function should only be called on a server. Never expose your service_role key in the browser.

signOut(jwt: string, scope?: "global" | "local" | "others"): Promise<{ data: null; error: AuthError | null; }>

Removes a logged-in session.

updateUserById(uid: string, attributes: AdminUserAttributes): Promise<UserResponse>

Updates the user data.

import supabase.GoTrueAdminApi
import { supabase } from "https://dotland.deno.dev/x/live@1.63.12/deps.ts";
const { GoTrueAdminApi } = supabase;