BaseAuth class

واجهة رئيسية مشتركة لكل من واجهات برمجة التطبيقات Auth وTenantAwareAuth

Signature:

export declare abstract class BaseAuth

الطُرق

الطريقة المعدِّلات الوصف
createCustomToken(uid, developerClaims) ينشئ رمزًا مميّزًا مخصّصًا جديدًا لـ Firebase (JWT) يمكن إرساله مرة أخرى إلى جهاز عميل لاستخدامه في تسجيل الدخول باستخدام طرق signInWithCustomToken() لحِزم تطوير البرامج (SDK) للعملاء. (ستضمّن مثيلات البرامج المستأجرة أيضًا رقم تعريف المستأجر في الرمز المميّز.)راجِع إنشاء رموز مميّزة مخصّصة للتعرُّف على عيّنات التعليمات البرمجية والمستندات التفصيلية.
createProviderConfig(config) لعرض وعد يتم حله مع AuthProviderConfig الذي تم إنشاؤه حديثًا عند إنشاء إعداد موفِّر الخدمة الجديد.يتطلّب دعم موفّري SAML وOIDC استخدام منصة Identity Platform (GCIP) في Google Cloud. لمزيد من المعلومات حول برنامج GCIP، بما في ذلك الأسعار والميزات، يمكنك الاطّلاع على مستندات برنامج GCIP.
createSessionCookie(idToken, sessionCookieOptions) تُنشئ ملف تعريف ارتباط جديدًا لجلسة Firebase باستخدام الخيارات المحدّدة. يمكن ضبط سلسلة JWT التي تم إنشاؤها كملف تعريف ارتباط جلسة من جهة الخادم مع سياسة مخصصة لملفات تعريف الارتباط، كما يمكن استخدامها لإدارة الجلسة. سيكون لملف تعريف الارتباط للجلسة JWT مطالبات الحمولة نفسها مثل الرمز المميز للمعرّف.راجع إدارة ملفات تعريف الارتباط للجلسة لعينات التعليمات البرمجية والمستندات التفصيلية.
createUser(الخصائص) إنشاء مستخدم جديد.يمكنك الاطّلاع على إنشاء مستخدم لنماذج الرموز البرمجية والمستندات التفصيلية.
deleteProviderConfig(providerId) يحذف إعدادات مقدّم الخدمة المقابلة لرقم تعريف الموفّر الذي تم تمريره. في حال عدم توفّر رقم التعريف المحدّد، يتم عرض خطأ auth/configuration-not-found.يتطلّب دعم موفّري SAML وOIDC توفّر Identity Platform (GCIP) في Google Cloud. لمزيد من المعلومات حول برنامج GCIP، بما في ذلك الأسعار والميزات، يمكنك الاطّلاع على مستندات برنامج GCIP.
deleteUser(uid) حذف مستخدم حالي.يمكنك الاطّلاع على حذف مستخدم للاطّلاع على عيّنات التعليمات البرمجية والمستندات التفصيلية.
deleteUsers(uids) يؤدي هذا الإجراء إلى حذف المستخدمين الذين حدّدهم المعرّفات الفريدة المقدَّمة.لن يؤدي حذف مستخدِم غير حالي إلى حدوث خطأ (أي أنّ هذه الطريقة فعّالة.) نعتبر أنّ المستخدمين غير الحاليين قد تم حذفهم بنجاح، وبالتالي يتم احتسابهم ضمن قيمة DeleteUsersResult.successCount.يمكن تقديم 1, 000 معرّف فقط كحد أقصى. إذا تم تقديم أكثر من 1, 000 معرّف، تعرض هذه الطريقة خطأ FirebaseAuthError.يُرجى العِلم أنّ معدّل سرعة واجهة برمجة التطبيقات هذه في الخادم يقتصر حاليًا على طلب واحد (QPS). وفي حال تجاوز هذا الحدّ، قد تتلقى رسالة خطأ بشأن تجاوز الحصة. وبالتالي، إذا أردت حذف أكثر من 1000 مستخدم، قد تحتاج إلى إضافة مهلة لضمان عدم تجاوز هذا الحدّ.
generateEmailverificationLink(email, actionCodeSettings) ينشئ رابط الإجراء "خارج الإطار" لإثبات ملكية المستخدم للبريد الإلكتروني المحدّد. يحدِّد الكائن ActionCodeSettings المقدم كوسيطة لهذه الطريقة ما إذا كان سيتم التعامل مع الرابط من خلال تطبيق متوافق مع الأجهزة الجوّالة أو متصفّح إلى جانب معلومات الحالة الإضافية التي سيتم تمريرها في الرابط لصفحة في التطبيق، وما إلى ذلك.
generatePasswordResetLink(email, actionCodeSettings) ينشئ رابط إجراء البريد الإلكتروني خارج النطاق لإعادة ضبط كلمة مرور مستخدم. يتم إنشاء الرابط للمستخدم الذي يملك عنوان البريد الإلكتروني المحدّد. يحدِّد الكائن الاختياري ActionCodeSettings ما إذا كان سيتم التعامل مع الرابط من خلال تطبيق أو متصفّح متوافق مع الأجهزة الجوّالة ومعلومات الحالة الإضافية التي سيتم تمريرها في الرابط لصفحة في التطبيق، وما إلى ذلك.
generateSignInWithEmailLink(email, actionCodeSettings) ينشئ رابط الإجراء "خارج الإطار" لإثبات ملكية المستخدم للبريد الإلكتروني المحدّد. يحدِّد الكائن ActionCodeSettings المقدم كوسيطة لهذه الطريقة ما إذا كان سيتم التعامل مع الرابط من خلال تطبيق متوافق مع الأجهزة الجوّالة أو متصفّح إلى جانب معلومات الحالة الإضافية التي سيتم تمريرها في الرابط لصفحة في التطبيق، وما إلى ذلك.
generateVerifyAndChangeEmailLink(email, newEmail, actionCodeSettings) ينشئ رابطًا لإجراء بريد إلكتروني خارج الإطار للتحقّق من ملكية المستخدم للبريد الإلكتروني المحدّد. يحدِّد الكائن ActionCodeSettings المقدم كوسيطة لهذه الطريقة ما إذا كان سيتم التعامل مع الرابط من خلال تطبيق متوافق مع الأجهزة الجوّالة أو متصفّح إلى جانب معلومات الحالة الإضافية التي سيتم تمريرها في الرابط لصفحة في التطبيق، وما إلى ذلك.
getProviderConfig(providerId) يتم البحث عن إعدادات موفِّر المصادقة من خلال رقم التعريف المقدَّم. تعرض وعدًا يتم مطابقته مع إعدادات الموفّر المقابلة لرقم تعريف الموفّر المحدّد. في حال عدم توفّر رقم التعريف المحدّد، يتم عرض خطأ auth/configuration-not-found.يتطلّب دعم موفّري SAML وOIDC توفّر Identity Platform (GCIP) في Google Cloud. لمزيد من المعلومات حول برنامج GCIP، بما في ذلك الأسعار والميزات، يمكنك الاطّلاع على مستندات برنامج GCIP.
getUser(uid) تتيح هذه الميزة الحصول على بيانات المستخدم الخاصة بعنصر uid محدّد.يمكنك الاطّلاع على المقالة استرداد بيانات المستخدم للاطّلاع على عيّنات التعليمات البرمجية والمستندات التفصيلية.
getUserByEmail(email) تتيح هذه الميزة الحصول على بيانات المستخدم الخاصة ببريد إلكتروني محدّد.يمكنك الاطّلاع على استرداد بيانات المستخدم للتعرُّف على عيّنات التعليمات البرمجية والمستندات التفصيلية.
getUserByPhoneNumber(phoneNumber) تحصل على بيانات المستخدم الخاصة بالمستخدم المقابل لرقم هاتف معيّن. يجب أن يتوافق رقم الهاتف مع مواصفات E.164.يمكنك الاطّلاع على استرداد بيانات المستخدم لنماذج الرموز والمستندات التفصيلية.
getUserByProviderUid(providerId, uid) تتيح هذه الميزة الحصول على بيانات المستخدم الخاصة بالمستخدم المقابل لمعرّف مقدّم خدمة معيّن.يمكنك الاطّلاع على استرداد بيانات المستخدم لنماذج الرموز والمستندات التفصيلية.
getUsers(identifiers) الحصول على بيانات المستخدم المقابلة للمعرّفات المحدّدة.لا تتوفّر أي ضمانات بشأن الطلب، لا يمكن على وجه التحديد ضمان توافق الإدخال رقم n في قائمة النتائج مع الإدخال رقم n في قائمة مَعلمات الإدخال.يمكن فقط توفير 100 معرّف كحدّ أقصى. في حال تقديم أكثر من 100 معرّف، تعرض هذه الطريقة خطأ FirebaseAuthError.
ImportUsers(users, options) لاستيراد قائمة المستخدمين المقدَّمة إلى تفويض Firebase. يُسمح باستيراد 1000 مستخدم كحدّ أقصى في المرة الواحدة. عند استيراد المستخدمين بكلمات مرور، يجب تحديد UserImportOptions. تم تحسين هذه العملية لعمليات الاستيراد المجمّعة وستتجاهل عمليات التحقّق على uid وemail وغير ذلك من المعرّفات الفريدة، ما قد يؤدي إلى ظهور نُسخ طبق الأصل.
listProviderConfigs(options) عرض قائمة إعدادات مقدّم الخدمة الحالية التي تتطابق مع الفلتر المقدَّم يمكن إدراج 100 إعداد كحدّ أقصى لمقدّم الخدمة في الوقت نفسه.يتطلّب دعم موفّري SAML وOIDC استخدام منصة Identity Platform (GCIP) في Google Cloud. لمزيد من المعلومات حول برنامج GCIP، بما في ذلك الأسعار والميزات، يمكنك الاطّلاع على مستندات برنامج GCIP.
listUsers(maxResults, pageToken) يسترد قائمة بالمستخدمين (دفعة واحدة فقط) بحجم maxResults بدءًا من الإزاحة كما هو محدّد في pageToken. يُستخدم هذا لاسترداد جميع مستخدمي مشروع محدّد على دفعات.راجِع قائمة كل المستخدمين للتعرّف على عيّنات التعليمات البرمجية والمستندات التفصيلية.
revokerefreshTokens(uid) تؤدي هذه السياسة إلى إبطال جميع الرموز المميَّزة لإعادة التحميل لمستخدِم حالي.ستعمل واجهة برمجة التطبيقات هذه على تعديل UserRecord.tokensMultipleafterTime للمستخدم إلى التوقيت العالمي المنسَّق (UTC) الحالي. من المهم أن يتم ضبط ساعة الخادم الذي تتم تسمية هذا الرمز عليه ومزامنتها بشكلٍ صحيح.على الرغم من أنّ ذلك سيؤدي إلى إبطال جميع الجلسات لمستخدم محدّد وإيقاف أي رموز مميزة جديدة لرقم التعريف في الجلسات الحالية، ولكن قد تظل رموز المعرِّف الحالية نشطة حتى انتهاء صلاحيتها الطبيعية (ساعة واحدة). للتحقّق من إبطال الرموز المميّزة لرقم التعريف، استخدِم BaseAuth.verifyIdToken() حيث تم ضبط checkRevoked على "صحيح".
setCustomUserClaims(uid, customUserClaims) لضبط مطالبات إضافية للمطوّرين بشأن مستخدم حالي يتم تحديده في uid المقدَّم، ويتم عادةً تحديد أدوار المستخدم ومستويات وصوله. يجب نشر هذه المطالبات على جميع الأجهزة التي سبق للمستخدم تسجيل الدخول إليها (بعد انتهاء صلاحية الرمز المميّز أو عند فرض إعادة تحميل الرمز المميّز) وفي المرة التالية التي يسجّل فيها المستخدم الدخول. في حال استخدام اسم مطالبة محجوز من خلال OIDC (sub أو iat أو iss أو غير ذلك)، ستظهر رسالة خطأ. ويتم ضبطها على الرمز المميّز لرقم تعريف المستخدم الذي تمت المصادقة عليه JWT.يُرجى الاطّلاع على تحديد أدوار المستخدم ومستويات الوصول لعيّنات التعليمات البرمجية والمستندات التفصيلية.
updateProviderConfig(providerId, updatedConfig) تعرض وعدًا يتم حلّه باستخدام AuthProviderConfig المعدَّلة المتوافقة مع رقم تعريف مقدّم الخدمة المحدّد. في حال عدم توفّر رقم التعريف المحدّد، يتم عرض خطأ auth/configuration-not-found.يتطلّب دعم موفّري SAML وOIDC توفّر Identity Platform (GCIP) في Google Cloud. لمزيد من المعلومات حول برنامج GCIP، بما في ذلك الأسعار والميزات، يمكنك الاطّلاع على مستندات برنامج GCIP.
updateUser(uid, properties) لتعديل مستخدم حالي.يمكنك الاطّلاع على تحديث مستخدم لنماذج الرموز البرمجية والمستندات التفصيلية.
verifyIdToken(idToken, check disapprovald) التحقّق من الرمز المميّز لمعرّف Firebase (JWT). إذا كان الرمز المميّز صالحًا، يتم تنفيذ الوعد من خلال المطالبات التي تم فك ترميزها، وإلا سيتم رفض الوعد.إذا تم ضبط السياسة checkRevoked على "صحيح"، يتم أولاً التأكّد مما إذا كان المستخدم المعنيّ موقوفًا. إذا كانت الإجابة بنعم، يتم عرض خطأ auth/user-disabled. إذا كانت الإجابة "لا"، يتم التحقّق مما إذا تم إبطال الجلسة المتوافقة مع الرمز المميّز لرقم التعريف. إذا تم إبطال صلاحية جلسة المستخدم المطابِقة، سيظهر خطأ auth/id-token-revoked. إذا لم يتم تحديد ذلك، لن يتم تطبيق الاختبار.يمكنك مراجعة التحقّق من الرموز المميّزة للمعرّفات للتعرّف على عيّنات التعليمات البرمجية والمستندات التفصيلية.
verifySessionCookie(sessionCookie, check disapprovald) التحقّق من ملف تعريف ارتباط جلسة Firebase. تعرض وعدًا بمطالبات ملفات تعريف الارتباط. يتم رفض الإذن في حال تعذّر التحقّق من ملف تعريف الارتباط.في حال ضبط السياسة checkRevoked على "صحيح"، يتم أولاً التحقّق مما إذا كان المستخدم المقابل غير مفعَّل: في هذه الحالة، سيتم عرض خطأ auth/user-disabled. إذا كانت الإجابة "لا"، يتم التحقّق مما إذا تم إبطال الجلسة المقابلة لملف تعريف الارتباط للجلسة. إذا تم إبطال صلاحية جلسة المستخدم المطابِقة، سيظهر خطأ auth/session-cookie-revoked. إذا لم يتم تحديد ذلك، لن يتم إجراء الفحص.يمكنك الاطّلاع على التحقّق من ملفات تعريف الارتباط للجلسة للتعرّف على عيّنات التعليمات البرمجية والمستندات التفصيلية.

BaseAuth.createCustomToken()

ينشئ رمزًا مميّزًا مخصّصًا جديدًا لـ Firebase (JWT) يمكن إرساله مرة أخرى إلى جهاز عميل لاستخدامه في تسجيل الدخول باستخدام طرق signInWithCustomToken() لحِزم تطوير البرامج (SDK) للعملاء. (ستتضمّن المثيلات الواعية بالمستأجر أيضًا رقم تعريف المستأجر في الرمز المميّز.)

يمكنك الاطّلاع على إنشاء رموز مميّزة مخصّصة للتعرُّف على عيّنات التعليمات البرمجية والمستندات التفصيلية.

Signature:

createCustomToken(uid: string, developerClaims?: object): Promise<string>;

المَعلمات

المَعلمة Type الوصف
المعرّف الفريد العالمي سلسلة uid المطلوب استخدامه كموضوع للرمز المميّز المخصّص.
مطالبات مطوّر البرامج كائن مطالبات إضافية اختيارية لتضمينها في حمولة الرمز المميّز المخصّص.

المرتجعات:

وعد<string>

يتم تنفيذ وعد من خلال رمز مميّز مخصّص للمكوّن الإضافي uid والحمولة.

BaseAuth.createProviderConfig()

عرض وعد يتم حله مع AuthProviderConfig التي تم إنشاؤها حديثًا عند إنشاء إعداد موفِّر الخدمة الجديد.

يتطلّب دعم موفّري SAML وOIDC توفُّر نظام Identity Platform (GCIP) في Google Cloud. لمزيد من المعلومات حول برنامج GCIP، بما في ذلك الأسعار والميزات، يمكنك الاطّلاع على مستندات برنامج GCIP.

Signature:

createProviderConfig(config: AuthProviderConfig): Promise<AuthProviderConfig>;

المَعلمات

المَعلمة Type الوصف
config AuthProviderConfig إعدادات الموفّر المطلوب إنشاؤها

المرتجعات:

الوعد<AuthProviderConfig>

وعد يتم حله مع إعدادات الموفّر التي تم إنشاؤها.

BaseAuth.createSessionCookie()

تُنشئ ملف تعريف ارتباط جديدًا لجلسة Firebase باستخدام الخيارات المحدّدة. يمكن ضبط سلسلة JWT التي تم إنشاؤها كملف تعريف ارتباط جلسة من جهة الخادم مع سياسة مخصصة لملفات تعريف الارتباط، كما يمكن استخدامها لإدارة الجلسة. سيكون لملف تعريف الارتباط للجلسة JWT مطالبات الحمولة نفسها مثل الرمز المميز للمعرّف الذي تم تقديمه.

يمكنك الاطّلاع على إدارة ملفات تعريف الارتباط للجلسة للتعرّف على عيّنات التعليمات البرمجية والمستندات التفصيلية.

Signature:

createSessionCookie(idToken: string, sessionCookieOptions: SessionCookieOptions): Promise<string>;

المَعلمات

المَعلمة Type الوصف
رمز المعرّف المميّز (IDToken) سلسلة الرمز المميّز لمعرّف Firebase لاستبدال ملف تعريف ارتباط الجلسة.
خيارات ملفّات تعريف الارتباط للجلسة SessionCookieOptions خيارات ملف تعريف الارتباط للجلسة التي تتضمّن مدة مخصّصة للجلسة.

المرتجعات:

وعد<string>

وعد يضمن تحقيق النجاح باستخدام ملف تعريف الارتباط الذي تم إنشاؤه للجلسة.

BaseAuth.createUser()

ينشئ مستخدمًا جديدًا.

ويمكنك الاطّلاع على قسم إنشاء مستخدم للتعرُّف على عيّنات التعليمات البرمجية والمستندات التفصيلية.

Signature:

createUser(properties: CreateRequest): Promise<UserRecord>;

المَعلمات

المَعلمة Type الوصف
المواقع CreateRequest السمات التي سيتم ضبطها في سجلّ المستخدِم الجديد المطلوب إنشاؤها.

المرتجعات:

تعهد بتقديم<UserRecord>

يتم الوفاء بالوعد الذي يتم الوفاء به من خلال بيانات المستخدم المقابلة للمستخدم الذي تم إنشاؤه حديثًا.

BaseAuth.deleteProviderConfig()

يحذف إعدادات مقدّم الخدمة المقابلة لرقم تعريف الموفّر الذي تم تمريره. إذا لم يتوفّر المعرّف المحدّد، يتم عرض خطأ auth/configuration-not-found.

يتطلّب دعم موفّري SAML وOIDC توفُّر نظام Identity Platform (GCIP) في Google Cloud. لمزيد من المعلومات حول برنامج GCIP، بما في ذلك الأسعار والميزات، يمكنك الاطّلاع على مستندات برنامج GCIP.

Signature:

deleteProviderConfig(providerId: string): Promise<void>;

المَعلمات

المَعلمة Type الوصف
رقم تعريف الموفّر سلسلة رقم تعريف الموفّر المتوافق مع إعدادات مقدّم الخدمة التي يجب حذفها.

المرتجعات:

وعد: < لِتَنْفِيذْ ذَلِكْ

تقديم وعد يحلّ المشكلة بعد اكتمالها

BaseAuth.deleteUser()

حذف مستخدم حالي

يُرجى الاطّلاع على القسم حذف مستخدم للاطّلاع على عيّنات التعليمات البرمجية والمستندات التفصيلية.

Signature:

deleteUser(uid: string): Promise<void>;

المَعلمات

المَعلمة Type الوصف
المعرّف الفريد العالمي سلسلة تمثّل هذه السمة uid المقابلة للمستخدم المطلوب حذفه.

المرتجعات:

وعد: < لِتَنْفِيذْ ذَلِكْ

يتم تنفيذ وعد فارغ بعد حذف حساب المستخدم.

BaseAuth.deleteUsers()

لحذف المستخدمين الذين حدّدهم المعرّفات الفريدة المقدَّمة

لن يؤدي حذف مستخدم غير موجود إلى حدوث خطأ (أي أن هذه الطريقة ثابتة.) نعتبر أنّ المستخدمين غير الحاليين قد تم حذفهم بنجاح، وبالتالي يتم احتسابهم ضمن قيمة DeleteUsersResult.successCount.

لا يمكن تقديم سوى 1,000 معرّف كحدّ أقصى. في حال تقديم أكثر من 1, 000 معرّف، تعرض هذه الطريقة خطأ FirebaseAuthError.

يقتصر معدّل استخدام واجهة برمجة التطبيقات هذه على الخادم على QPS واحد. وفي حال تجاوز هذا الحدّ، قد تتلقى رسالة خطأ بشأن تجاوز الحصة. وبالتالي، إذا أردت حذف أكثر من 1000 مستخدم، قد تحتاج إلى إضافة مهلة لضمان عدم تجاوز هذا الحدّ.

Signature:

deleteUsers(uids: string[]): Promise<DeleteUsersResult>;

المَعلمات

المَعلمة Type الوصف
المعرّفات الفريدة سلسلة[] تمثّل هذه السمة uids للمستخدمين الذين سيتم حذفهم.

المرتجعات:

الوعد<DeleteUsersResult>

وعد يحلّ العدد الإجمالي لعمليات الحذف الناجحة/غير الناجحة، بالإضافة إلى مصفوفة الأخطاء المرتبطة بعمليات الحذف غير الناجحة.

ينشئ رابط الإجراء "خارج الإطار" لإثبات ملكية المستخدم للبريد الإلكتروني المحدّد. يحدِّد الكائن ActionCodeSettings المقدم كوسيطة لهذه الطريقة ما إذا كان سيتم التعامل مع الرابط من خلال تطبيق متوافق مع الأجهزة الجوّالة أو متصفّح إلى جانب معلومات الحالة الإضافية التي سيتم تمريرها في الرابط لصفحة في التطبيق، وما إلى ذلك.

Signature:

generateEmailVerificationLink(email: string, actionCodeSettings?: ActionCodeSettings): Promise<string>;

المَعلمات

المَعلمة Type الوصف
بريد إلكتروني سلسلة حساب البريد الإلكتروني المطلوب إثبات ملكيته.
إعدادات رمز الإجراء ActionCodeSettings إعدادات رمز الإجراء. إذا تم تحديد عنوان URL للحالة/المتابعة، يتم ضبطه على أنّه المَعلمة "continueUrl" في رابط التحقق من البريد الإلكتروني. ستستخدم الصفحة المقصودة التلقائية لإثبات ملكية عنوان البريد الإلكتروني هذا الرابط لعرض رابط للرجوع إلى التطبيق في حال كان مثبّتًا. في حال عدم تحديد actionsCodeSettings، لن يتم إلحاق عنوان URL بعنوان URL للإجراء. يجب أن ينتمي عنوان URL الخاص بالولاية إلى نطاق أدرجه مطوِّر البرامج في القائمة البيضاء في وحدة التحكّم. وإلا يتم عرض خطأ. لا تسري عمليات إعادة التوجيه للتطبيقات المتوافقة مع الأجهزة الجوّالة إلا في حال إعداد المطوِّر لبنود خدمة "روابط Firebase الديناميكية" وقبولها. تتم مراعاة اسم حزمة Android ومعرّف حزمة iOS فقط إذا تم ضبطهما في مشروع تفويض Firebase نفسه.

المرتجعات:

وعد<string>

تقديم وعد يتم التعامل معه باستخدام الرابط الذي يتم إنشاؤه

مثال

var actionCodeSettings = {
  url: 'https://www.example.com/cart?email=user@example.com&cartId=123',
  iOS: {
    bundleId: 'com.example.ios'
  },
  android: {
    packageName: 'com.example.android',
    installApp: true,
    minimumVersion: '12'
  },
  handleCodeInApp: true,
  dynamicLinkDomain: 'custom.page.link'
};
admin.auth()
    .generateEmailVerificationLink('user@example.com', actionCodeSettings)
    .then(function(link) {
      // The link was successfully generated.
    })
    .catch(function(error) {
      // Some error occurred, you can inspect the code: error.code
    });

ينشئ رابط إجراء البريد الإلكتروني خارج النطاق لإعادة ضبط كلمة مرور مستخدم. يتم إنشاء الرابط للمستخدم الذي يملك عنوان البريد الإلكتروني المحدّد. يحدِّد الكائن الاختياري ActionCodeSettings ما إذا كان سيتم التعامل مع الرابط من خلال تطبيق أو متصفّح متوافق مع الأجهزة الجوّالة ومعلومات الحالة الإضافية التي سيتم تمريرها في الرابط لصفحة في التطبيق، وما إلى ذلك.

Signature:

generatePasswordResetLink(email: string, actionCodeSettings?: ActionCodeSettings): Promise<string>;

المَعلمات

المَعلمة Type الوصف
بريد إلكتروني سلسلة عنوان البريد الإلكتروني للمستخدم الذي ستتم إعادة ضبط كلمة المرور الخاصة به.
إعدادات رمز الإجراء ActionCodeSettings إعدادات رمز الإجراء. إذا تم تحديد عنوان URL للحالة/المتابعة، يتم ضبطه كمعلمة "continueUrl" في رابط إعادة تعيين كلمة المرور. ستستخدم الصفحة المقصودة التلقائية لإعادة ضبط كلمة المرور هذا الرابط لعرض رابط للرجوع إلى التطبيق في حال كان مثبّتًا. في حال عدم تحديد actionsCodeSettings، لن يتم إلحاق عنوان URL بعنوان URL للإجراء. يجب أن ينتمي عنوان URL الخاص بالولاية إلى نطاق أدرجه مطوِّر البرامج في القائمة البيضاء في وحدة التحكّم. وإلا يتم عرض خطأ. لا تسري عمليات إعادة التوجيه للتطبيقات المتوافقة مع الأجهزة الجوّالة إلا في حال إعداد المطوِّر لبنود خدمة "روابط Firebase الديناميكية" وقبولها. تتم مراعاة اسم حزمة Android ومعرّف حزمة iOS فقط إذا تم ضبطهما في مشروع تفويض Firebase نفسه.

المرتجعات:

وعد<string>

تقديم وعد يتم التعامل معه باستخدام الرابط الذي يتم إنشاؤه

مثال

var actionCodeSettings = {
  url: 'https://www.example.com/?email=user@example.com',
  iOS: {
    bundleId: 'com.example.ios'
  },
  android: {
    packageName: 'com.example.android',
    installApp: true,
    minimumVersion: '12'
  },
  handleCodeInApp: true,
  dynamicLinkDomain: 'custom.page.link'
};
admin.auth()
    .generatePasswordResetLink('user@example.com', actionCodeSettings)
    .then(function(link) {
      // The link was successfully generated.
    })
    .catch(function(error) {
      // Some error occurred, you can inspect the code: error.code
    });

ينشئ رابط الإجراء "خارج الإطار" لإثبات ملكية المستخدم للبريد الإلكتروني المحدّد. يحدِّد الكائن ActionCodeSettings المقدم كوسيطة لهذه الطريقة ما إذا كان سيتم التعامل مع الرابط من خلال تطبيق متوافق مع الأجهزة الجوّالة أو متصفّح إلى جانب معلومات الحالة الإضافية التي سيتم تمريرها في الرابط لصفحة في التطبيق، وما إلى ذلك.

Signature:

generateSignInWithEmailLink(email: string, actionCodeSettings: ActionCodeSettings): Promise<string>;

المَعلمات

المَعلمة Type الوصف
بريد إلكتروني سلسلة حساب البريد الإلكتروني المطلوب إثبات ملكيته.
إعدادات رمز الإجراء ActionCodeSettings إعدادات رمز الإجراء. إذا تم تحديد عنوان URL للحالة/المتابعة، يتم ضبطه على أنّه المَعلمة "continueUrl" في رابط التحقق من البريد الإلكتروني. ستستخدم الصفحة المقصودة التلقائية لإثبات ملكية عنوان البريد الإلكتروني هذا الرابط لعرض رابط للرجوع إلى التطبيق في حال كان مثبّتًا. في حال عدم تحديد actionsCodeSettings، لن يتم إلحاق عنوان URL بعنوان URL للإجراء. يجب أن ينتمي عنوان URL الخاص بالولاية إلى نطاق أدرجه مطوِّر البرامج في القائمة البيضاء في وحدة التحكّم. وإلا يتم عرض خطأ. لا تسري عمليات إعادة التوجيه للتطبيقات المتوافقة مع الأجهزة الجوّالة إلا في حال إعداد المطوِّر لبنود خدمة "روابط Firebase الديناميكية" وقبولها. تتم مراعاة اسم حزمة Android ومعرّف حزمة iOS فقط إذا تم ضبطهما في مشروع تفويض Firebase نفسه.

المرتجعات:

وعد<string>

تقديم وعد يتم التعامل معه باستخدام الرابط الذي يتم إنشاؤه

مثال

var actionCodeSettings = {
  url: 'https://www.example.com/cart?email=user@example.com&cartId=123',
  iOS: {
    bundleId: 'com.example.ios'
  },
  android: {
    packageName: 'com.example.android',
    installApp: true,
    minimumVersion: '12'
  },
  handleCodeInApp: true,
  dynamicLinkDomain: 'custom.page.link'
};
admin.auth()
    .generateEmailVerificationLink('user@example.com', actionCodeSettings)
    .then(function(link) {
      // The link was successfully generated.
    })
    .catch(function(error) {
      // Some error occurred, you can inspect the code: error.code
    });

ينشئ رابطًا لإجراء بريد إلكتروني خارج الإطار للتحقّق من ملكية المستخدم للبريد الإلكتروني المحدّد. يحدِّد الكائن ActionCodeSettings المقدم كوسيطة لهذه الطريقة ما إذا كان سيتم التعامل مع الرابط من خلال تطبيق متوافق مع الأجهزة الجوّالة أو متصفّح إلى جانب معلومات الحالة الإضافية التي سيتم تمريرها في الرابط لصفحة في التطبيق، وما إلى ذلك.

Signature:

generateVerifyAndChangeEmailLink(email: string, newEmail: string, actionCodeSettings?: ActionCodeSettings): Promise<string>;

المَعلمات

المَعلمة Type الوصف
بريد إلكتروني سلسلة حساب البريد الإلكتروني الحالي
رسالة إلكترونية جديدة سلسلة عنوان البريد الإلكتروني الذي يتم تحديث الحساب إليه.
إعدادات رمز الإجراء ActionCodeSettings إعدادات رمز الإجراء. إذا تم تحديد عنوان URL للحالة/المتابعة، يتم ضبطه على أنّه المَعلمة "continueUrl" في رابط التحقق من البريد الإلكتروني. ستستخدم الصفحة المقصودة التلقائية لإثبات ملكية عنوان البريد الإلكتروني هذا الرابط لعرض رابط للرجوع إلى التطبيق في حال كان مثبّتًا. في حال عدم تحديد actionsCodeSettings، لن يتم إلحاق عنوان URL بعنوان URL للإجراء. يجب أن ينتمي عنوان URL الخاص بالولاية إلى نطاق تمت مصادقته في وحدة التحكم، وإلا سيتم عرض خطأ. لا تسري عمليات إعادة التوجيه للتطبيقات المتوافقة مع الأجهزة الجوّالة إلا في حال إعداد المطوِّر لبنود خدمة "روابط Firebase الديناميكية" وقبولها. تتم مراعاة اسم حزمة Android ومعرّف حزمة iOS فقط إذا تم ضبطهما في مشروع تفويض Firebase نفسه.

المرتجعات:

وعد<string>

تقديم وعد يتم التعامل معه باستخدام الرابط الذي يتم إنشاؤه

BaseAuth.getProviderConfig()

يتم البحث عن إعدادات موفِّر المصادقة من خلال رقم التعريف المقدَّم. تعرض وعدًا يتم مطابقته مع إعدادات الموفّر المقابلة لرقم تعريف الموفّر المحدّد. إذا لم يتوفّر المعرّف المحدّد، يتم عرض خطأ auth/configuration-not-found.

يتطلّب دعم موفّري SAML وOIDC توفُّر نظام Identity Platform (GCIP) في Google Cloud. لمزيد من المعلومات حول برنامج GCIP، بما في ذلك الأسعار والميزات، يمكنك الاطّلاع على مستندات برنامج GCIP.

Signature:

getProviderConfig(providerId: string): Promise<AuthProviderConfig>;

المَعلمات

المَعلمة Type الوصف
رقم تعريف الموفّر سلسلة رقم تعريف الموفّر المتوافق مع إعدادات مقدّم الخدمة المطلوب عرضها.

المرتجعات:

الوعد<AuthProviderConfig>

وعد تتم مطابقته مع الإعدادات المقابلة لرقم التعريف الذي تم تقديمه.

BaseAuth.getUser()

للحصول على بيانات المستخدم المتوافقة مع uid محدّد.

يُرجى الاطّلاع على استرداد بيانات المستخدم للتعرّف على عيّنات التعليمات البرمجية والمستندات التفصيلية.

Signature:

getUser(uid: string): Promise<UserRecord>;

المَعلمات

المَعلمة Type الوصف
المعرّف الفريد العالمي سلسلة تمثّل هذه السمة uid للمستخدم الذي يتم جلب بياناته.

المرتجعات:

تعهد بتقديم<UserRecord>

تم الوفاء بالوعد المطلوب من خلال بيانات المستخدمين المتوافقة مع uid المقدَّمة.

BaseAuth.getUserByEmail()

تحصل على بيانات المستخدم الخاصة بالمستخدم المقابل لبريد إلكتروني معيّن.

يُرجى الاطّلاع على استرداد بيانات المستخدم للتعرّف على عيّنات التعليمات البرمجية والمستندات التفصيلية.

Signature:

getUserByEmail(email: string): Promise<UserRecord>;

المَعلمات

المَعلمة Type الوصف
بريد إلكتروني سلسلة البريد الإلكتروني المقابل للمستخدم الذي سيتم جلب بياناته.

المرتجعات:

تعهد بتقديم<UserRecord>

تم الوفاء بالوعد الذي تم إجراؤه باستخدام بيانات المستخدمين المتوافقة مع عنوان البريد الإلكتروني المقدَّم.

BaseAuth.getUserByPhoneNumber()

تحصل على بيانات المستخدم الخاصة بالمستخدم المقابل لرقم هاتف معيّن. يجب أن يتوافق رقم الهاتف مع مواصفات E.164.

يُرجى الاطّلاع على استرداد بيانات المستخدم للتعرّف على عيّنات التعليمات البرمجية والمستندات التفصيلية.

Signature:

getUserByPhoneNumber(phoneNumber: string): Promise<UserRecord>;

المَعلمات

المَعلمة Type الوصف
رقم الهاتف سلسلة رقم الهاتف المقابل للمستخدم الذي سيتم جلب بياناته.

المرتجعات:

تعهد بتقديم<UserRecord>

يتم تنفيذ الوعد ببيانات المستخدم المقابلة لرقم الهاتف المقدَّم.

BaseAuth.getUserByProviderUid()

تحصل على بيانات المستخدم الخاصة بالمستخدم المقابلة لرقم تعريف موفّر معيّن.

يُرجى الاطّلاع على استرداد بيانات المستخدم للتعرّف على عيّنات التعليمات البرمجية والمستندات التفصيلية.

Signature:

getUserByProviderUid(providerId: string, uid: string): Promise<UserRecord>;

المَعلمات

المَعلمة Type الوصف
رقم تعريف الموفّر سلسلة رقم تعريف المزوّد، مثل "google.com" لمقدّم خدمة Google.
المعرّف الفريد العالمي سلسلة تمثّل هذه السمة معرّف المستخدم لمقدّم الخدمة المحدّد.

المرتجعات:

تعهد بتقديم<UserRecord>

يتم تنفيذ وعد باستخدام بيانات المستخدمين المقابلة لرقم تعريف مقدّم الخدمة المحدّد.

BaseAuth.getUsers()

يتم الحصول على بيانات المستخدمين المقابلة للمعرّفات المحدّدة.

لا توجد أي ضمانات بالترتيب، وعلى وجه الخصوص، لا يمكن ضمان تطابق الإدخال رقم n في قائمة النتائج مع الإدخال رقم n في قائمة مَعلمات الإدخال.

لا يمكن توفير أكثر من 100 معرّف. في حال تقديم أكثر من 100 معرّف، تعرض هذه الطريقة خطأ FirebaseAuthError.

Signature:

getUsers(identifiers: UserIdentifier[]): Promise<GetUsersResult>;

المَعلمات

المَعلمة Type الوصف
المعرّفات معرّف المستخدم[] المعرّفات المستخدَمة للإشارة إلى سجلّات المستخدمين التي يجب عرضها. يجب ألا يحتوي على أكثر من 100 إدخال.

المرتجعات:

وعد<GetUsersResult>

وعد يتم حله وفقًا لسجلات المستخدم ذات الصلة.

الاستثناءات

FirebaseAuthError إذا كان أي من المعرّفات غير صالح أو إذا تم تحديد أكثر من 100 معرّف.

BaseAuth.importUsers()

لاستيراد قائمة المستخدمين المقدَّمة إلى تفويض Firebase. يُسمح باستيراد 1000 مستخدم كحدّ أقصى في المرة الواحدة. عند استيراد المستخدمين بكلمات مرور، يجب تحديد UserImportOptions. تم تحسين هذه العملية لعمليات الاستيراد المجمّعة وستتجاهل عمليات التحقّق على uid وemail وغير ذلك من المعرّفات الفريدة، ما قد يؤدي إلى ظهور نُسخ طبق الأصل.

Signature:

importUsers(users: UserImportRecord[], options?: UserImportOptions): Promise<UserImportResult>;

المَعلمات

المَعلمة Type الوصف
المستخدمون UserImportLog[] قائمة سجلّات المستخدمين المطلوب استيرادها إلى تفويض Firebase.
خيارات UserImportOptions تكون خيارات استيراد المستخدم مطلوبة عندما يُدرج المستخدمون المقدّمون بيانات اعتماد كلمة المرور.

المرتجعات:

الوعد<UserImportResult>

وعد يتم التعامل معه عند اكتمال العملية ونتيجة الاستيراد. ويشمل ذلك عدد عمليات الاستيراد الناجحة وعدد عمليات الاستيراد التي تعذّر إجراؤها والأخطاء المقابلة لها.

BaseAuth.listProviderConfigs()

عرض قائمة إعدادات مقدّم الخدمة الحالية التي تتطابق مع الفلتر المقدَّم يمكن إدراج 100 إعداد خاص بمقدّم الخدمة كحدّ أقصى في آنٍ واحد.

يتطلّب دعم موفّري SAML وOIDC توفُّر نظام Identity Platform (GCIP) في Google Cloud. لمزيد من المعلومات حول برنامج GCIP، بما في ذلك الأسعار والميزات، يمكنك الاطّلاع على مستندات برنامج GCIP.

Signature:

listProviderConfigs(options: AuthProviderConfigFilter): Promise<ListProviderConfigResults>;

المَعلمات

المَعلمة Type الوصف
خيارات AuthProviderConfigFilter فلتر إعدادات مقدّم الخدمة المطلوب تطبيقه

المرتجعات:

الوعد<ListProviderConfigResults>

وعد يتم التعامل معه استنادًا إلى قائمة إعدادات مقدّم الخدمة التي تفي بمتطلبات الفلترة.

BaseAuth.listUsers()

يسترد قائمة بالمستخدمين (دفعة واحدة فقط) بحجم maxResults بدءًا من الإزاحة على النحو المحدّد في pageToken. يُستخدم هذا لاسترداد جميع مستخدمي مشروع محدد على دفعات.

يمكنك الاطّلاع على قائمة بجميع المستخدمين للاطّلاع على عيّنات التعليمات البرمجية والمستندات التفصيلية.

Signature:

listUsers(maxResults?: number, pageToken?: string): Promise<ListUsersResult>;

المَعلمات

المَعلمة Type الوصف
الحد الأقصى للنتائج عدد حجم الصفحة، 1000 إذا لم يتم تحديده. وهذا هو أيضًا الحدّ الأقصى المسموح به.
رمز الصفحة سلسلة الرمز المميز للصفحة التالية. وفي حال عدم تحديدها، يتم عرض المستخدمين الذين يبدأون بدون أي إزاحة.

المرتجعات:

الوعد<ListUsersResult>

وعد يتم حله مع الدفعة الحالية من المستخدمين الذين تم تنزيلهم والرمز المميز للصفحة التالية.

BaseAuth.revokePreviewTokens()

يؤدي هذا الإجراء إلى إبطال جميع الرموز المميّزة لإعادة التحميل لمستخدِم حالي.

ستعمل واجهة برمجة التطبيقات هذه على تحديث UserRecord.tokensصالحafterTime للمستخدم إلى التوقيت العالمي المنسَّق (UTC) الحالي. ومن المهم أن يتم ضبط ساعته بشكل صحيح ومزامنتها على الخادم الذي يتم استدعاؤه عليه.

على الرغم من أنّ هذا الإجراء سيؤدي إلى إبطال جميع الجلسات لمستخدم محدّد وإيقاف أي رموز مميزة جديدة لرقم التعريف للجلسات الحالية، قد تظل رموز المعرّف الحالية نشطة حتى انتهاء صلاحيتها الطبيعية (ساعة واحدة). للتحقّق من إبطال الرموز المميّزة لرقم التعريف، استخدِم BaseAuth.verifyIdToken() حيث تم ضبط checkRevoked على "صحيح".

Signature:

revokeRefreshTokens(uid: string): Promise<void>;

المَعلمات

المَعلمة Type الوصف
المعرّف الفريد العالمي سلسلة تشير هذه السمة إلى uid المقابلة للمستخدم الذي تم إبطال الرموز المميّزة لإعادة التحميل لديه.

المرتجعات:

وعد: < لِتَنْفِيذْ ذَلِكْ

يتم تنفيذ وعود فارغ بعد إبطال الرموز المميّزة لإعادة التحميل الخاصة بالمستخدم.

BaseAuth.setCustomUserClaims()

لضبط مطالبات إضافية للمطوّرين بشأن مستخدم حالي يتم تحديده في uid المقدّمة، ويتم عادةً تحديد أدوار المستخدم ومستويات وصوله. يجب نشر هذه المطالبات على جميع الأجهزة التي سبق للمستخدم تسجيل الدخول إليها (بعد انتهاء صلاحية الرمز المميّز أو عند فرض إعادة تحميل الرمز المميّز) وفي المرة التالية التي يسجّل فيها المستخدم الدخول. في حال استخدام اسم مطالبة محجوز من خلال OIDC (sub أو iat أو iss أو غير ذلك)، ستظهر رسالة خطأ. يتم ضبطها على الرمز المميز لمعرّف المستخدم الذي تمت مصادقته، JWT.

يُرجى الاطّلاع على تحديد أدوار المستخدم ومستويات الوصول للتعرّف على عيّنات التعليمات البرمجية والمستندات التفصيلية.

Signature:

setCustomUserClaims(uid: string, customUserClaims: object | null): Promise<void>;

المَعلمات

المَعلمة Type الوصف
المعرّف الفريد العالمي سلسلة تمثّل هذه السمة uid للمستخدم المطلوب تعديله.
مطالبات المستخدمين المخصّصة كائن | فارغ يطالب المطوّر بالإعداد. وفي حال عدم إدخال قيمة فارغة، يتم حذف المطالبات المخصّصة الحالية. سيؤدي تمرير حمولة مطالبات مخصصة أكبر من 1000 بايت إلى حدوث خطأ. تتمّ إضافة المطالبات المخصّصة إلى الرمز المميّز لمعرّف المستخدم والذي يتم نقله على كل طلب تمت مصادقته. بالنسبة إلى سمات المستخدمين التي لا تتعلق بالوصول إلى الملف الشخصي، استخدِم قاعدة البيانات أو أنظمة تخزين منفصلة أخرى.

المرتجعات:

وعد: < لِتَنْفِيذْ ذَلِكْ

وعد يتم حله عند اكتمال العملية بنجاح.

BaseAuth.updateProviderConfig()

تعرض وعدًا يتم حلّه باستخدام AuthProviderConfig المعدَّلة المتوافقة مع رقم تعريف مقدّم الخدمة المحدّد. إذا لم يتوفّر المعرّف المحدّد، يتم عرض خطأ auth/configuration-not-found.

يتطلّب دعم موفّري SAML وOIDC توفُّر نظام Identity Platform (GCIP) في Google Cloud. لمزيد من المعلومات حول برنامج GCIP، بما في ذلك الأسعار والميزات، يمكنك الاطّلاع على مستندات برنامج GCIP.

Signature:

updateProviderConfig(providerId: string, updatedConfig: UpdateAuthProviderRequest): Promise<AuthProviderConfig>;

المَعلمات

المَعلمة Type الوصف
رقم تعريف الموفّر سلسلة رقم تعريف الموفّر المتوافق مع إعدادات مقدّم الخدمة المطلوب تعديلها
تاريخ الضبط المحدَّث UpdateAuthProviderRequest الإعدادات المعدَّلة.

المرتجعات:

الوعد<AuthProviderConfig>

وعد يتم حله عند تطبيق الإعدادات المعدَّلة لمقدّم الخدمة.

BaseAuth.updateUser()

لتعديل بيانات مستخدم حالي

يُرجى مراجعة القسم تحديث مستخدم للاطّلاع على عيّنات التعليمات البرمجية والمستندات التفصيلية.

Signature:

updateUser(uid: string, properties: UpdateRequest): Promise<UserRecord>;

المَعلمات

المَعلمة Type الوصف
المعرّف الفريد العالمي سلسلة تمثّل هذه السمة uid المرتبطة بالمستخدم الذي يجب تعديله.
المواقع UpdateRequest السمات المطلوب تعديلها في المستخدِم المقدَّم

المرتجعات:

تعهد بتقديم<UserRecord>

تم الوفاء بالوعد الخاص ببيانات المستخدمين المعدّلة.

BaseAuth.verifyIdToken()

التحقّق من الرمز المميّز لمعرّف Firebase (JWT). إذا كان الرمز المميّز صالحًا، يتم تنفيذ الوعد بالادعاءات التي تم فك ترميزها، وإلا سيتم رفض الوعد.

في حال ضبط السياسة checkRevoked على "صحيح"، تتأكّد أولاً مما إذا كان قد تم إيقاف المستخدم المعني. إذا كانت الإجابة بنعم، يتم عرض خطأ auth/user-disabled. إذا كانت الإجابة "لا"، يتم التحقّق مما إذا تم إبطال الجلسة المتوافقة مع الرمز المميّز لرقم التعريف. إذا تم إبطال صلاحية جلسة المستخدم المطابِقة، سيظهر خطأ auth/id-token-revoked. إذا لم يتم تحديده، لن يتم تطبيق الشيك.

يمكنك الاطّلاع على صفحة التحقّق من الرموز المميّزة للمعرّفات للاطّلاع على عيّنات التعليمات البرمجية والمستندات التفصيلية.

Signature:

verifyIdToken(idToken: string, checkRevoked?: boolean): Promise<DecodedIdToken>;

المَعلمات

المَعلمة Type الوصف
رمز المعرّف المميّز (IDToken) سلسلة الرمز المميّز لرقم التعريف المطلوب إثبات ملكيته.
تم إبطال الاختيار منطقية التأكّد مما إذا تم إبطال الرمز المميّز للمعرّف ويتطلّب هذا الإجراء طلبًا إضافيًا إلى الواجهة الخلفية لمصادقة Firebase من أجل التحقّق من وقت tokensValidAfterTime للمستخدِم المقابل. وعند عدم تحديدها، لا يتم تطبيق عملية الفحص الإضافية هذه.

المرتجعات:

الوعد<DecodedIdToken>

الوعد الذي يتم تنفيذه بالمطالبات التي تم فك ترميزها في حال كان الرمز المميّز الخاص بالمعرّف صالحًا، وإلا سيتم رفضه.

BaseAuth.verifySessionCookie()

التحقّق من ملف تعريف ارتباط جلسة Firebase. تعرض وعدًا بمطالبات ملفات تعريف الارتباط. يرفض هذا الإذن في حال تعذّر التحقّق من ملف تعريف الارتباط.

إذا تم ضبط السياسة checkRevoked على "صحيح"، تتأكّد أولاً مما إذا كان المستخدم المعنيّ موقوفًا: إذا كانت الإجابة "نعم"، سيتم عرض خطأ auth/user-disabled. إذا كانت الإجابة "لا"، يتم التحقّق مما إذا تم إبطال الجلسة المقابلة لملف تعريف الارتباط للجلسة. إذا تم إبطال صلاحية جلسة المستخدم المطابِقة، سيظهر خطأ auth/session-cookie-revoked. إذا لم يتم تحديد ذلك، لا يتم إجراء عملية التحقق.

يمكنك الاطّلاع على التحقق من ملفات تعريف الارتباط للجلسة للحصول على عيّنات من التعليمات البرمجية والمستندات التفصيلية.

Signature:

verifySessionCookie(sessionCookie: string, checkRevoked?: boolean): Promise<DecodedIdToken>;

المَعلمات

المَعلمة Type الوصف
ملف تعريف الارتباط للجلسة سلسلة ملف تعريف الارتباط للجلسة المطلوب إثبات ملكيته.
تم إبطال الاختيار منطقية

المرتجعات:

الوعد<DecodedIdToken>

وعد يتم تنفيذه من خلال المطالبات التي تم فك ترميزها في ملف تعريف الارتباط للجلسة إذا كان ملف تعريف الارتباط للجلسة صالحًا، وإلا سيتم تنفيذ وعد مرفوض.