JavaScript SDK: verificatiereferentie
Elke authenticatie- en gebruikersbeheermethode, met zijn handtekening.
6 min lezen·Niveau referentie·Herzien op 12 okt 2026
Deze Engelse tekst is automatisch gegenereerd op basis van het Franse origineel en is nog niet beoordeeld.
Deze pagina is automatisch vertaald. De Engelse versie is gezaghebbend.
#
Functies
Geëxporteerde functies
| Functie | Beschrijving |
|---|---|
function isMfaChallenge(v: unknown): v is MfaChallenge | Discriminerende beschermkap LoginResponse = TokenPair | MfaChallenge. |
#
Klasse
AuthService
| Methode | Beschrijving |
|---|---|
dispose(): void | Ontmantelt de proactieve levenscyclus: ticker, zichtbaarheid, BroadcastChannel, luisteraars. |
onAuthStateChange(callback: AuthStateCallback): { unsubscribe: () => void; data: { subscription: { unsubscribe: () => void; }; }; } | Luistert naar wijzigingen in de sessiestatus (SIGNED_IN, SIGNED_OUT, TOKEN_REFRESHED, USER_UPDATED, MFA_CHALLENGE…). |
signUp(req: SignUpRequest): Promise<AuraResponse<LoginResponse>> | Maak een account aan met e-mailadres en wachtwoord. |
signInWithPassword(req: SignInRequest): Promise<AuraResponse<LoginResponse>> | Meldt een gebruiker aan met e-mailadres en wachtwoord. |
signInWithOAuth(provider: string, options?: OAuthSignInOptions): Promise<AuraResponse<{ url: string; }>> | Start een OAuth-stroom: retourneert altijd { url } (en leidt bovendien de browser om als er een window bestaat). |
signInWithMagicLink(req: MagicLinkRequest): Promise<AuraResponse<{ message: string; }>> | Verstuurt een verbindingslink per e-mail (“magische link”). |
signInAnonymously(): Promise<AuraResponse<TokenPair>> | Creëert een anonieme sessie (gebruiker zonder e-mail), opgenomen en gerapporteerd door SIGNED_IN. |
signOut(): Promise<AuraResponse<null>> | Verbinding verbreken: trekt het vernieuwingstoken aan de serverzijde in als dit bestaat, wist de lokale sessie en geeft SIGNED_OUT uit. |
refreshSession(): Promise<AuraResponse<TokenPair>> | Vernieuwt de sessie met het vernieuwingstoken en geeft TOKEN_REFRESHED uit. |
getSession(): Promise<{ data: { session: Session | null; }; error: null; accessToken: string | null; access_token: string | null; user: User | null; }> | Huidige sessie uitgelezen uit de winkel (in de praktijk synchroon, geen netwerkoproep). |
setSession(accessToken: string, refreshToken: string): Promise<AuraResponse<User>> | Installeert een sessie vanaf een bestaand toegangstoken en vernieuwingstoken (bijvoorbeeld ontvangen van een server). |
exchangeCodeForSession(authCode: string, codeVerifier?: string): Promise<AuraResponse<LoginResponse>> | Wisselt de PKCE-autorisatiecode uit voor een sessie. |
listSessions(): Promise<AuraResponse<SessionInfo[]>> | Geeft een overzicht van de sessies van de ingelogde gebruiker (apparaat, IP-adres, datums); is_current lokaliseert de huidige sessie. |
revokeSession(sessionId: string): Promise<AuraResponse<null>> | Trekt een sessie in van de gebruiker die verbonden is door zijn of haar ID. |
revokeAllSessions(): Promise<AuraResponse<{ message: string; }>> | Meldt de gebruiker overal af: trekt al zijn sessies in, wist de lokale sessie en geeft SIGNED_OUT uit. |
getUser(jwt?: string): Promise<AuraResponse<User>> | Haalt de gevalideerde gebruiker op aan de serverzijde. |
getClaims(jwt?: string, options?: { allowExpired?: boolean; issuer?: string; audience?: string; }): Promise<AuraResponse<GetClaimsResult>> | Verifieert en decodeert de claims van een JWT. |
deleteUser(password: string): Promise<AuraResponse<null>> | Verwijdert het account van de verbonden gebruiker na bevestiging met zijn wachtwoord en wist vervolgens de lokale sessie. |
updateUser(req: UpdateUserRequest): Promise<AuraResponse<User>> | Werkt de ingelogde gebruiker bij (metagegevens, wachtwoord, enz.) en geeft USER_UPDATED uit. |
resetPasswordForEmail(req: PasswordResetRequest): Promise<AuraResponse<{ message: string; }>> | Stuurt een e-mail voor het opnieuw instellen van het wachtwoord. |
updatePassword(newPassword: string, currentPassword?: string): Promise<AuraResponse<User>> | Wijzigt het wachtwoord van de ingelogde gebruiker. |
mfaEnroll(): Promise<AuraResponse<MfaEnrollResponse>> | MFA: start de TOTP-inschrijving en retourneert de secret en de URL otpauth_url om weer te geven als een QR-code. |
mfaVerifySetup(code: string): Promise<AuraResponse<{ recovery_codes: string[]; }>> | MFA: bevestigt de inschrijving met een eerste code en retourneert de herstelcodes. |
mfaVerify(req: MfaVerifyRequest): Promise<AuraResponse<TokenPair>> | MFA: beëindigt een verbinding die een uitdaging retourneert (mfa_token en TOTP-code). |
mfaUnenroll(password: string): Promise<AuraResponse<{ message: string; }>> | MFA: deactiveert MFA na bevestiging met het wachtwoord. |
verifyOtp(params: VerifyEmailChangeOtpParams): Promise<AuraResponse<User>>verifyOtp(params: Exclude<VerifyOtpParams, VerifyEmailChangeOtpParams>): Promise<AuraResponse<TokenPair>> | ENKEL toegangspunt voor OTP-verificatie (pariteit verifyOtp of @supabase/auth-js). |
resendVerificationEmail(email?: string): Promise<AuraResponse<{ message: string; }>> | Verzendt de verificatie-e-mail opnieuw naar email of naar het adres van de ingelogde gebruiker. |
signInWithEmailOtp(email: string): Promise<AuraResponse<{ message: string; }>> | Stuurt een eenmalige gebruikscode per e-mail; te bevestigen door verifyOtp({ type: 'email' }). |
signInWithSmsOtp(phone: string): Promise<AuraResponse<{ message: string; }>> | Stuurt een eenmalige code per sms; te bevestigen door verifyOtp({ type: 'sms' }). |
listIdentities(): Promise<AuraResponse<IdentityInfo[]>> | Geeft een overzicht van de identiteiten (providers) die aan de ingelogde gebruiker zijn gekoppeld. |
linkIdentity(provider: string): Promise<AuraResponse<{ url: string; provider: string; }>> | Begint met het binden van een provider OAuth aan het verbonden account en retourneert de autorisatie-URL om te openen. |
unlinkIdentity(identityId: string): Promise<AuraResponse<{ message: string; }>> | Ontkoppelt een identiteit van het account dat is verbonden door de ID ervan. |
regenerateRecoveryCodes(code: string): Promise<AuraResponse<{ recovery_codes: string[]; }>> | MFA: genereert de herstelcodes opnieuw na bevestiging met een TOTP-code. |
signInWithIdToken(provider: string, idToken: string, accessToken?: string): Promise<AuraResponse<LoginResponse>> | Wisselt een providertoken-ID (Google/Apple, native mobiel) uit voor een sessie. |
getSettings(): Promise<AuraResponse<{ disable_signup: boolean; external: Record<string, boolean>; mailer_autoconfirm: boolean; mfa_enabled: boolean; }>> | GoTrue-pariteit: GET /settings - openbare projectconfiguratie (geen authenticatie vereist). |
getAnonKey(): Promise<AuraResponse<{ anon_key: string; }>> | Publiceerbare sleutel (anon-sleutel) van het project — GET /anon-key (openbaar, zoals het Supabase-model). |
resetPassword(token: string, newPassword: string): Promise<AuraResponse<TokenPair>> | Verbruikt het wachtwoordhersteltoken en past het nieuwe wachtwoord toe. |
promoteAnonymous(credentials: { email: string; password: string; }): Promise<AuraResponse<TokenPair>> | Converteert de huidige anonieme gebruiker (JWT vereist) naar een normaal e-mail- en wachtwoordaccount. |
verifyMagicLink(token: string): Promise<AuraResponse<TokenPair>> | Verbruikt het magische linktoken en retourneert een TokenPair. |
#
Klasse
AuthAdminService
| Methode | Beschrijving |
|---|---|
listUsers(params?: { limit?: number; offset?: number; search?: string; }): Promise<AuraResponse<AdminUser[]>> | Geeft projectgebruikers weer, met zoekopdracht (search) en paginering (limit, offset). |
getUser(userId: string): Promise<AuraResponse<AdminUser>> | Leest een gebruiker op basis van zijn ID. |
createUser(data: AdminCreateUserRequest): Promise<AuraResponse<AdminUser>> | Creëert een gebruiker zonder een openbare registratie te doorlopen (e-mailadres, wachtwoord, metadata, rol). |
updateUser(userId: string, data: AdminUpdateUserRequest): Promise<AuraResponse<AdminUser>> | Update een gebruiker: alleen de opgegeven velden veranderen. |
deleteUser(userId: string): Promise<AuraResponse<null>> | Verwijder een gebruiker. |
banUser(userId: string): Promise<AuraResponse<null>> | Bant een gebruiker: hij kan niet meer inloggen. |
unbanUser(userId: string): Promise<AuraResponse<null>> | Hef de ban van een gebruiker op. |
generateLink(userId: string, type: GenerateLinkType): Promise<AuraResponse<GenerateLinkResult>> | Genereert een eenmalige link voor een gebruiker ('magic', 'recovery' of 'invite') en retourneert { link, token }. |
getUserStats(): Promise<AuraResponse<UserStats>> | Gebruikersstatistieken: totaal, geverifieerd, verbannen, met MFA en nieuw gedurende 7 dagen. |
listUserIdentities(userId: string): Promise<AuraResponse<IdentityInfo[]>> | Geeft identiteiten weer die zijn gekoppeld aan een gebruiker (OAuth providers, e-mail). |
listSessions(params?: { userId?: string; limit?: number; offset?: number; }): Promise<AuraResponse<AdminSessionInfo[]>> | Geeft een overzicht van actieve sessies van alle gebruikers, filterbaar op userId, met paginering. |
revokeSession(sessionId: string): Promise<AuraResponse<null>> | Trekt een sessie in op basis van de ID. |
getAuditLog(params?: { userId?: string; limit?: number; offset?: number; }): Promise<AuraResponse<AuditLogEntry[]>> | Leest het auditlogboek (actie, IP-adres, user-agent, datum), filterbaar op userId, met paging. |
getSettings(): Promise<AuraResponse<AuthSettings>> | Leest de authenticatie-instellingen van het project. |
updateSettings(data: AuthSettingsUpdate): Promise<AuraResponse<AuthSettings>> | Werkt de auth-instellingen van het project bij (gedeeltelijke samenvoeging: alleen de opgegeven velden worden geschreven, COALESCE aan de backend-kant). |
listEmailTemplates(): Promise<AuraResponse<Record<string, unknown>[]>> | Geeft e-mailsjablonen voor projectverificatie weer. |
getEmailTemplate(type: string): Promise<AuraResponse<Record<string, unknown>>> | Leest de e-mailsjabloon van een bepaald type (bijvoorbeeld bevestiging, herstel). |
updateEmailTemplate(type: string, data: EmailTemplateUpdate): Promise<AuraResponse<Record<string, unknown>>> | Vervangt de inhoud van e-mailsjablonen van een bepaald type. |
deleteEmailTemplate(type: string): Promise<AuraResponse<{ message: string; }>> | Verwijdert de aangepaste sjabloon uit een e-mailtype. |
testEmailTemplate(type: string, body: { to_email: string; }): Promise<AuraResponse<null>> | Stuurt een test-e-mail met een typesjabloon naar het adres to_email. |
Gegenereerde pagina
Deze pagina wordt gegenereerd op basis van de typedeclaraties en opmerkingen van de SDK, zodat deze niet kan afwijken van de gepubliceerde code. Lees de handleidingen voor uitgewerkte voorbeelden.
Laatst bijgewerkt · 12 okt 2026