जावास्क्रिप्ट एसडीके: प्रामाणिक संदर्भ
प्रत्येक प्रमाणीकरण और उपयोगकर्ता-प्रशासन विधि, अपने हस्ताक्षर के साथ।
6 मि॰ पढ़ें·स्तर संदर्भ·12 अक्टू॰ 2026 पर संशोधित
यह अंग्रेजी पाठ फ़्रेंच मूल से स्वचालित रूप से उत्पन्न हुआ था और अभी तक इसकी समीक्षा नहीं की गई है।
यह पृष्ठ स्वचालित रूप से अनुवादित किया गया था. अंग्रेजी संस्करण प्रामाणिक है.
#
कार्य
निर्यात किए गए कार्य
| समारोह | विवरण |
|---|---|
function isMfaChallenge(v: unknown): v is MfaChallenge | विभेदक प्रकार गार्ड LoginResponse = TokenPair | MfaChallenge। |
#
कक्षा
प्रामाणिक सेवा
| तरीका | विवरण |
|---|---|
dispose(): void | सक्रिय जीवनचक्र को नष्ट कर देता है: टिकर, दृश्यता, ब्रॉडकास्ट चैनल, श्रोता। |
onAuthStateChange(callback: AuthStateCallback): { unsubscribe: () => void; data: { subscription: { unsubscribe: () => void; }; }; } | सत्र स्थिति परिवर्तन (SIGNED_IN, SIGNED_OUT, TOKEN_REFRESHED, USER_UPDATED, MFA_CHALLENGE…) सुनता है। |
signUp(req: SignUpRequest): Promise<AuraResponse<LoginResponse>> | ईमेल और पासवर्ड से एक खाता बनाएं. |
signInWithPassword(req: SignInRequest): Promise<AuraResponse<LoginResponse>> | किसी उपयोगकर्ता को ईमेल और पासवर्ड द्वारा लॉग इन करता है। |
signInWithOAuth(provider: string, options?: OAuthSignInOptions): Promise<AuraResponse<{ url: string; }>> | एक OAuth प्रवाह शुरू करता है: हमेशा { url } लौटाता है (और यदि window मौजूद है तो इसके अतिरिक्त ब्राउज़र को रीडायरेक्ट करता है)। |
signInWithMagicLink(req: MagicLinkRequest): Promise<AuraResponse<{ message: string; }>> | ईमेल द्वारा एक कनेक्शन लिंक भेजता है ("मैजिक लिंक")। |
signInAnonymously(): Promise<AuraResponse<TokenPair>> | एक अनाम सत्र (ईमेल के बिना उपयोगकर्ता) बनाता है, जिसे SIGNED_IN द्वारा रिकॉर्ड और रिपोर्ट किया जाता है। |
signOut(): Promise<AuraResponse<null>> | डिस्कनेक्ट: यदि सर्वर-साइड रीफ्रेश टोकन मौजूद है तो उसे रद्द कर देता है, स्थानीय सत्र को फ्लश कर देता है, और SIGNED_OUT जारी करता है। |
refreshSession(): Promise<AuraResponse<TokenPair>> | ताज़ा टोकन के साथ सत्र को ताज़ा करता है और TOKEN_REFRESHED जारी करता है। |
getSession(): Promise<{ data: { session: Session | null; }; error: null; accessToken: string | null; access_token: string | null; user: User | null; }> | वर्तमान सत्र स्टोर से पढ़ा गया (व्यवहार में समकालिक, कोई नेटवर्क कॉल नहीं)। |
setSession(accessToken: string, refreshToken: string): Promise<AuraResponse<User>> | मौजूदा एक्सेस टोकन और रीफ्रेश टोकन से एक सत्र स्थापित करता है (उदाहरण के लिए सर्वर से प्राप्त)। |
exchangeCodeForSession(authCode: string, codeVerifier?: string): Promise<AuraResponse<LoginResponse>> | एक सत्र के लिए PKCE प्राधिकरण कोड का आदान-प्रदान करता है। |
listSessions(): Promise<AuraResponse<SessionInfo[]>> | लॉग इन किए गए उपयोगकर्ता के सत्र (डिवाइस, आईपी पता, तिथियां) सूचीबद्ध करता है; is_current वर्तमान सत्र का पता लगाता है। |
revokeSession(sessionId: string): Promise<AuraResponse<null>> | अपने पहचानकर्ता से जुड़े उपयोगकर्ता के सत्र को रद्द करता है। |
revokeAllSessions(): Promise<AuraResponse<{ message: string; }>> | उपयोगकर्ता को हर जगह लॉग आउट करता है: उनके सभी सत्रों को रद्द करता है, स्थानीय सत्र को फ्लश करता है, और SIGNED_OUT जारी करता है। |
getUser(jwt?: string): Promise<AuraResponse<User>> | सर्वर साइड पर मान्य उपयोगकर्ता को पुनः प्राप्त करता है। |
getClaims(jwt?: string, options?: { allowExpired?: boolean; issuer?: string; audience?: string; }): Promise<AuraResponse<GetClaimsResult>> | JWT के दावों को सत्यापित और डिकोड करता है। |
deleteUser(password: string): Promise<AuraResponse<null>> | कनेक्टेड उपयोगकर्ता के पासवर्ड से पुष्टि के बाद उसका खाता हटा देता है, फिर स्थानीय सत्र साफ़ कर देता है। |
updateUser(req: UpdateUserRequest): Promise<AuraResponse<User>> | लॉग इन उपयोगकर्ता (मेटाडेटा, पासवर्ड, आदि) को अपडेट करता है और USER_UPDATED जारी करता है। |
resetPasswordForEmail(req: PasswordResetRequest): Promise<AuraResponse<{ message: string; }>> | एक पासवर्ड रीसेट ईमेल भेजता है. |
updatePassword(newPassword: string, currentPassword?: string): Promise<AuraResponse<User>> | लॉग इन उपयोगकर्ता का पासवर्ड बदलता है। |
mfaEnroll(): Promise<AuraResponse<MfaEnrollResponse>> | MFA: TOTP नामांकन प्रारंभ करता है और QR कोड के रूप में प्रदर्शित करने के लिए secret और URL otpauth_url लौटाता है। |
mfaVerifySetup(code: string): Promise<AuraResponse<{ recovery_codes: string[]; }>> | MFA: पहले कोड के साथ नामांकन की पुष्टि करता है और पुनर्प्राप्ति कोड लौटाता है। |
mfaVerify(req: MfaVerifyRequest): Promise<AuraResponse<TokenPair>> | MFA: उस कनेक्शन को समाप्त करता है जिसने चुनौती (mfa_token और TOTP कोड) लौटाई है। |
mfaUnenroll(password: string): Promise<AuraResponse<{ message: string; }>> | MFA: पासवर्ड से पुष्टि के बाद MFA को निष्क्रिय कर देता है। |
verifyOtp(params: VerifyEmailChangeOtpParams): Promise<AuraResponse<User>>verifyOtp(params: Exclude<VerifyOtpParams, VerifyEmailChangeOtpParams>): Promise<AuraResponse<TokenPair>> | ओटीपी सत्यापन का एकल प्रवेश बिंदु (@supabase/auth-js की समता verifyOtp)। |
resendVerificationEmail(email?: string): Promise<AuraResponse<{ message: string; }>> | सत्यापन ईमेल को email या लॉग इन उपयोगकर्ता के पते पर पुनः भेजता है। |
signInWithEmailOtp(email: string): Promise<AuraResponse<{ message: string; }>> | ईमेल द्वारा एक बार उपयोग कोड भेजता है; verifyOtp({ type: 'email' }) द्वारा पुष्टि की जानी है। |
signInWithSmsOtp(phone: string): Promise<AuraResponse<{ message: string; }>> | एसएमएस द्वारा एक बार का कोड भेजता है; verifyOtp({ type: 'sms' }) द्वारा पुष्टि की जानी है। |
listIdentities(): Promise<AuraResponse<IdentityInfo[]>> | लॉग इन उपयोगकर्ता से जुड़ी पहचान (प्रदाताओं) को सूचीबद्ध करता है। |
linkIdentity(provider: string): Promise<AuraResponse<{ url: string; provider: string; }>> | एक प्रदाता OAuth को कनेक्टेड खाते से जोड़ना प्रारंभ करता है और प्राधिकरण URL को खोलने के लिए लौटाता है। |
unlinkIdentity(identityId: string): Promise<AuraResponse<{ message: string; }>> | किसी पहचान को उसके पहचानकर्ता से जुड़े खाते से अलग कर देता है। |
regenerateRecoveryCodes(code: string): Promise<AuraResponse<{ recovery_codes: string[]; }>> | MFA: TOTP कोड के साथ पुष्टि के बाद पुनर्प्राप्ति कोड पुन: उत्पन्न करता है। |
signInWithIdToken(provider: string, idToken: string, accessToken?: string): Promise<AuraResponse<LoginResponse>> | एक सत्र के लिए प्रदाता टोकन आईडी (Google/Apple, मूल मोबाइल) का आदान-प्रदान करता है। |
getSettings(): Promise<AuraResponse<{ disable_signup: boolean; external: Record<string, boolean>; mailer_autoconfirm: boolean; mfa_enabled: boolean; }>> | GoTrue समता: GET /सेटिंग्स - सार्वजनिक प्रोजेक्ट कॉन्फ़िगरेशन (कोई प्रमाणीकरण आवश्यक नहीं)। |
getAnonKey(): Promise<AuraResponse<{ anon_key: string; }>> | प्रोजेक्ट की प्रकाशनयोग्य कुंजी (anon key) - GET /anon-key (सार्वजनिक, Supabase मॉडल की तरह)। |
resetPassword(token: string, newPassword: string): Promise<AuraResponse<TokenPair>> | पासवर्ड पुनर्प्राप्ति टोकन का उपभोग करता है और नया पासवर्ड लागू करता है। |
promoteAnonymous(credentials: { email: string; password: string; }): Promise<AuraResponse<TokenPair>> | वर्तमान अनाम उपयोगकर्ता (JWT आवश्यक) को एक नियमित ईमेल+पासवर्ड खाते में परिवर्तित करता है। |
verifyMagicLink(token: string): Promise<AuraResponse<TokenPair>> | मैजिक लिंक टोकन का उपभोग करता है और एक टोकनपेयर लौटाता है। |
#
कक्षा
AuthAdminService
| तरीका | विवरण |
|---|---|
listUsers(params?: { limit?: number; offset?: number; search?: string; }): Promise<AuraResponse<AdminUser[]>> | खोज (search) और पेजिनेशन (limit, offset) के साथ प्रोजेक्ट उपयोगकर्ताओं को सूचीबद्ध करता है। |
getUser(userId: string): Promise<AuraResponse<AdminUser>> | किसी उपयोगकर्ता को उनकी आईडी से पढ़ता है। |
createUser(data: AdminCreateUserRequest): Promise<AuraResponse<AdminUser>> | सार्वजनिक पंजीकरण (ईमेल, पासवर्ड, मेटाडेटा, भूमिका) से गुजरे बिना एक उपयोगकर्ता बनाता है। |
updateUser(userId: string, data: AdminUpdateUserRequest): Promise<AuraResponse<AdminUser>> | उपयोगकर्ता को अपडेट करता है: केवल दिए गए फ़ील्ड बदलते हैं। |
deleteUser(userId: string): Promise<AuraResponse<null>> | किसी उपयोगकर्ता को हटाएँ. |
banUser(userId: string): Promise<AuraResponse<null>> | किसी उपयोगकर्ता को प्रतिबंधित करता है: वह अब लॉग इन नहीं कर सकता। |
unbanUser(userId: string): Promise<AuraResponse<null>> | उपयोगकर्ता का प्रतिबंध हटाएँ. |
generateLink(userId: string, type: GenerateLinkType): Promise<AuraResponse<GenerateLinkResult>> | उपयोगकर्ता के लिए एक बार का लिंक जेनरेट करता है ('magic', 'recovery', या 'invite') और { link, token } लौटाता है। |
getUserStats(): Promise<AuraResponse<UserStats>> | उपयोगकर्ता आँकड़े: कुल, सत्यापित, प्रतिबंधित, MFA के साथ और 7 दिनों में नया। |
listUserIdentities(userId: string): Promise<AuraResponse<IdentityInfo[]>> | उपयोगकर्ता से जुड़ी पहचानों को सूचीबद्ध करता है (OAuth प्रदाता, ईमेल)। |
listSessions(params?: { userId?: string; limit?: number; offset?: number; }): Promise<AuraResponse<AdminSessionInfo[]>> | पेजिनेशन के साथ userId द्वारा फ़िल्टर करने योग्य सभी उपयोगकर्ताओं के सक्रिय सत्र सूचीबद्ध करता है। |
revokeSession(sessionId: string): Promise<AuraResponse<null>> | किसी सत्र को उसके पहचानकर्ता द्वारा रद्द करता है। |
getAuditLog(params?: { userId?: string; limit?: number; offset?: number; }): Promise<AuraResponse<AuditLogEntry[]>> | ऑडिट लॉग (कार्रवाई, आईपी पता, उपयोगकर्ता एजेंट, दिनांक) को पेजिंग के साथ userId द्वारा फ़िल्टर किया जा सकता है। |
getSettings(): Promise<AuraResponse<AuthSettings>> | प्रोजेक्ट की प्रमाणीकरण सेटिंग्स पढ़ता है। |
updateSettings(data: AuthSettingsUpdate): Promise<AuraResponse<AuthSettings>> | प्रोजेक्ट की ऑथ सेटिंग्स को अपडेट करता है (आंशिक मर्ज: केवल प्रदान किए गए फ़ील्ड लिखे जाते हैं, बैकएंड साइड पर COALESCE)। |
listEmailTemplates(): Promise<AuraResponse<Record<string, unknown>[]>> | प्रोजेक्ट प्रमाणीकरण ईमेल टेम्प्लेट सूचीबद्ध करता है। |
getEmailTemplate(type: string): Promise<AuraResponse<Record<string, unknown>>> | किसी दिए गए प्रकार का ईमेल टेम्पलेट पढ़ता है (जैसे पुष्टिकरण, पुनर्प्राप्ति)। |
updateEmailTemplate(type: string, data: EmailTemplateUpdate): Promise<AuraResponse<Record<string, unknown>>> | किसी दिए गए प्रकार की ईमेल टेम्पलेट सामग्री को प्रतिस्थापित करता है। |
deleteEmailTemplate(type: string): Promise<AuraResponse<{ message: string; }>> | ईमेल प्रकार से कस्टम टेम्पलेट हटा देता है. |
testEmailTemplate(type: string, body: { to_email: string; }): Promise<AuraResponse<null>> | एक प्रकार के टेम्पलेट के साथ एक परीक्षण ईमेल पते to_email पर भेजता है। |
जनरेट किया गया पेज
यह पृष्ठ एसडीके की प्रकार की घोषणाओं और टिप्पणियों से उत्पन्न हुआ है, इसलिए यह प्रकाशित कोड से अलग नहीं हो सकता है। कारगर उदाहरणों के लिए, मार्गदर्शिकाएँ पढ़ें।
आखरी अपडेट · 12 अक्टू॰ 2026