Hi there! Are you looking for the official Deno documentation? Try docs.deno.com for all your Deno learning needs.

GoTrueAdminOAuthApi

import type { GoTrueAdminOAuthApi } from "https://esm.sh/@supabase/supabase-js@2.89.0/dist/index.d.mts";

Contains all OAuth client administration methods. Only relevant when the OAuth 2.1 server is enabled in Supabase Auth.

interface GoTrueAdminOAuthApi {

createClient(params: CreateOAuthClientParams): Promise<OAuthClientResponse>;

deleteClient(clientId: string): Promise<{

data: null;

error: AuthError | null;

}>;

getClient(clientId: string): Promise<OAuthClientResponse>;

listClients(params?: PageParams): Promise<OAuthClientListResponse>;

regenerateClientSecret(clientId: string): Promise<OAuthClientResponse>;

updateClient(clientId: string, params: UpdateOAuthClientParams): Promise<OAuthClientResponse>;

}

§Methods

createClient(params: CreateOAuthClientParams): Promise<OAuthClientResponse>

Creates a new OAuth client. Only relevant when the OAuth 2.1 server is enabled in Supabase Auth.

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

deleteClient(clientId: string): Promise<{

data: null;

error: AuthError | null;

}>

Deletes an OAuth client. Only relevant when the OAuth 2.1 server is enabled in Supabase Auth.

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

getClient(clientId: string): Promise<OAuthClientResponse>

Gets details of a specific OAuth client. Only relevant when the OAuth 2.1 server is enabled in Supabase Auth.

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

listClients(params?: PageParams): Promise<OAuthClientListResponse>

Lists all OAuth clients with optional pagination. Only relevant when the OAuth 2.1 server is enabled in Supabase Auth.

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

regenerateClientSecret(clientId: string): Promise<OAuthClientResponse>

Regenerates the secret for an OAuth client. Only relevant when the OAuth 2.1 server is enabled in Supabase Auth.

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

updateClient(clientId: string, params: UpdateOAuthClientParams): Promise<OAuthClientResponse>

Updates an existing OAuth client. Only relevant when the OAuth 2.1 server is enabled in Supabase Auth.

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