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

GoTrueAdminCustomProvidersApi

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

Contains all custom OIDC/OAuth provider administration methods.

interface GoTrueAdminCustomProvidersApi {
createProvider(params: CreateCustomProviderParams): Promise<CustomProviderResponse>;
deleteProvider(identifier: string): Promise<{
data: null;
error: AuthError | null;
}>;
getProvider(identifier: string): Promise<CustomProviderResponse>;
listProviders(params?: ListCustomProvidersParams): Promise<CustomProviderListResponse>;
updateProvider(identifier: string, params: UpdateCustomProviderParams): Promise<CustomProviderResponse>;
}

§Methods

§
createProvider(params: CreateCustomProviderParams): Promise<CustomProviderResponse>
[src]

Creates a new custom OIDC/OAuth provider.

For OIDC providers, the server fetches and validates the OpenID Connect discovery document from the issuer's well-known endpoint (or the provided discovery_url) at creation time. This may return a validation error (error_code: "validation_failed") if the discovery document is unreachable, not valid JSON, missing required fields, or if the issuer in the document does not match the expected issuer.

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

§
deleteProvider(identifier: string): Promise<{
data: null;
error: AuthError | null;
}>
[src]

Deletes a custom provider.

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

§
getProvider(identifier: string): Promise<CustomProviderResponse>
[src]

Gets details of a specific custom provider by identifier.

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

§
listProviders(params?: ListCustomProvidersParams): Promise<CustomProviderListResponse>
[src]

Lists all custom providers with optional type filter.

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

§
updateProvider(identifier: string, params: UpdateCustomProviderParams): Promise<CustomProviderResponse>
[src]

Updates an existing custom provider.

When issuer or discovery_url is changed on an OIDC provider, the server re-fetches and validates the discovery document before persisting. This may return a validation error (error_code: "validation_failed") if the discovery document is unreachable, invalid, or the issuer does not match.

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