واجهة Auth الواعية بالمستأجرين وتُستخدَم لإدارة المستخدمين، وضبط موفّري SAML/OIDC، وإنشاء روابط بريد إلكتروني لإعادة ضبط كلمة المرور، وإثبات ملكية عنوان البريد الإلكتروني، وما إلى ذلك للمستأجرين المحدّدين.
يتطلب دعم الإقامة المتعددة استخدام GCIP من Google Cloud. لمزيد من المعلومات حول برنامج GCIP، بما في ذلك الأسعار والميزات، يمكنك الاطّلاع على وثائق GCIP.
يحتوي كل مستأجر على موفِّري الهوية والإعدادات ومجموعات المستخدمين الخاصة به. باستخدام TenantAwareAuth، يمكن أيضًا إدارة مستخدمي مستأجر معيّن وإجراء إعدادات OIDC/SAML المقابلة، كما يمكن إثبات ملكية الرموز المميّزة للمستخدمين الذين سجّلوا الدخول إلى مستأجر محدّد. ويمكن أيضًا إنشاء روابط إجراءات عبر البريد الإلكتروني للمستخدمين الذين ينتمون إلى المستأجر.
يمكن إنشاء مثيل TenantAwareAuth لعنصر tenantId محدّد من خلال استدعاء TenantManager.authForTenant().
Signature:
export declare class TenantAwareAuth extends BaseAuth
للتوسيع: BaseAuth
أماكن إقامة
| الموقع | المعدِّلات | النوع | الوصف |
|---|---|---|---|
| tenantId | السلسلة | معرّف المستأجر المقابل لمثيل TenantAwareAuth هذا. لن يتم تطبيق جميع الطلبات الخاصة بواجهات برمجة التطبيقات لإدارة المستخدمين وواجهات برمجة التطبيقات لإدارة موفّر OIDC/SAML وواجهات برمجة التطبيقات لإنشاء روابط البريد الإلكتروني وما إلى ذلك إلا في نطاق هذا المستأجر. |
الطُرق
| الطريقة | المعدِّلات | الوصف |
|---|---|---|
| createSessionCookie(idToken, sessionCookieOptions) | تُنشئ ملف تعريف ارتباط جديدًا لجلسة Firebase باستخدام الخيارات المحدّدة. يمكن ضبط سلسلة JWT التي تم إنشاؤها كملف تعريف ارتباط جلسة من جهة الخادم باستخدام سياسة مخصّصة لملفات تعريف الارتباط، كما يمكن استخدامها في إدارة الجلسة. سيكون لملف تعريف ارتباط الجلسة JWT نفس مطالبات حمولة البيانات التي يتم تقديمها مثل الرمز المميّز لرقم التعريف.يمكنك الاطّلاع على إدارة ملفات تعريف ارتباط الجلسة للتعرُّف على عيّنات التعليمات البرمجية والمستندات التفصيلية. | |
| verifyIdToken(idToken, checkDisabled) | يتحقق من رمز مميز لرقم تعريف Firebase (JWT). إذا كان الرمز المميّز صالحًا، يتم الوفاء بالوعد من خلال المطالبات التي تم فك ترميزها الخاصة بالرمز المميّز وبخلاف ذلك، يتم رفض الوعد.في حال ضبط السياسة checkRevoked على "صحيح"، يتحقق أولاً مما إذا كان المستخدم ذي الصلة غير مفعَّل. إذا كانت الإجابة "نعم"، سيتم عرض خطأ auth/user-disabled. إذا كانت الإجابة "لا"، يتم التحقّق مما إذا تم إبطال الجلسة المقابلة للرمز المميّز للمعرّف. وفي حال إلغاء صلاحية جلسة المستخدم المقابلة، يتم عرض خطأ auth/id-token-revoked. في حال عدم تحديد هذه القيم، لن يتم تطبيق التحقّق.يمكنك الاطّلاع على التحقق من الرموز المميّزة للمعرّفات للاطّلاع على نماذج الرموز والمستندات المفصّلة. |
|
| verifySessionCookie(sessionCookie, checkDisabled) | التحقّق من ملف تعريف ارتباط جلسة Firebase يعرض تعهدًا بالمطالبات بملكية ملفات تعريف الارتباط. يرفض الوعد في حال تعذّر التحقق من ملف تعريف الارتباط.إذا تم ضبط checkRevoked على "صحيح"، يتحقق أولاً مما إذا كان المستخدم المعني متوقفًا: أما إذا كانت الإجابة "نعم"، فسيتم عرض الخطأ auth/user-disabled. إذا كانت الإجابة "لا"، يتم التحقّق مما إذا تم إبطال الجلسة المقابلة لملف تعريف الارتباط للجلسة. وإذا تم إبطال صلاحية جلسة المستخدم المقابلة، يتم عرض خطأ auth/session-cookie-revoked. إذا لم يتم تحديد، لن يتم إجراء عملية الفحص.يمكنك الاطّلاع على التحقق من ملفات تعريف ارتباط الجلسة للتعرُّف على عيّنات التعليمات البرمجية والمستندات التفصيلية. |
رقم تعريف TenantAwareAuth.tenantId
معرّف المستأجر المقابل لمثيل TenantAwareAuth هذا. لن يتم تطبيق جميع الطلبات الخاصة بواجهات برمجة التطبيقات لإدارة المستخدمين وواجهات برمجة التطبيقات لإدارة موفّر OIDC/SAML وواجهات برمجة التطبيقات لإنشاء روابط البريد الإلكتروني وما إلى ذلك إلا في نطاق هذا المستأجر.
Signature:
readonly tenantId: string;
TenantAwareAuth.createSessionCookie()
تُنشئ ملف تعريف ارتباط جديدًا لجلسة Firebase باستخدام الخيارات المحدّدة. يمكن ضبط سلسلة JWT التي تم إنشاؤها كملف تعريف ارتباط جلسة من جهة الخادم باستخدام سياسة مخصّصة لملفات تعريف الارتباط، كما يمكن استخدامها في إدارة الجلسة. سيحصل ملف تعريف ارتباط الجلسة JWT على نفس مطالبات حمولة البيانات التي يوفّرها الرمز المميّز للمعرّف الذي تم تقديمه.
يُرجى الاطّلاع على إدارة ملفات تعريف الارتباط للجلسة للحصول على عيّنات التعليمات البرمجية والمستندات التفصيلية.
Signature:
createSessionCookie(idToken: string, sessionCookieOptions: SessionCookieOptions): Promise<string>;
المَعلمات
| المعلمة | النوع | الوصف |
|---|---|---|
| الرمز المميّز | السلسلة | الرمز المميز لرقم تعريف Firebase لاستبدال ملف تعريف ارتباط الجلسة. |
| خيارات جلسة ملفات تعريف الارتباط | sessionCookieOptions | خيارات ملفات تعريف الارتباط للجلسة التي تتضمّن مدّة مخصّصة للجلسة |
المرتجعات:
وعود<string>
وعد يتم حله عند تحقيق النجاح باستخدام ملف تعريف الارتباط للجلسة الذي تم إنشاؤه.
TenantAwareAuth.verifyIdToken()
يتحقق من رمز مميز لرقم تعريف Firebase (JWT). إذا كان الرمز المميّز صالحًا، يتم الوفاء بالوعد من خلال المطالبات التي تم فك ترميزها الخاصة بالرمز المميّز وإلا فسيتم رفض الوعد.
إذا تم ضبط السياسة checkRevoked على "صحيح"، يتحقق أولاً مما إذا كان المستخدم المعني متوقفًا. إذا كانت الإجابة "نعم"، سيتم عرض خطأ auth/user-disabled. إذا كانت الإجابة "لا"، يتم التحقّق مما إذا تم إبطال الجلسة المقابلة للرمز المميّز للمعرّف. وإذا تم إبطال صلاحية جلسة المستخدم المقابلة، يتم عرض خطأ auth/id-token-revoked. في حال عدم تحديد قيمة، لن يتم تطبيق التحقّق.
ويمكنك مراجعة التحقق من الرموز المميّزة للمعرّفات للاطّلاع على نماذج الرموز والمستندات التفصيلية.
Signature:
verifyIdToken(idToken: string, checkRevoked?: boolean): Promise<DecodedIdToken>;
المَعلمات
| المعلمة | النوع | الوصف |
|---|---|---|
| الرمز المميّز | السلسلة | الرمز المميّز لرقم التعريف المطلوب إثبات ملكيته |
| تم إبطال علامة الاختيار | قيمة منطقية | للتحقّق مما إذا تم إبطال الرمز المميّز للمعرّف أم لا ويتطلّب ذلك إرسال طلب إضافي إلى الواجهة الخلفية لمصادقة Firebase للتحقّق من وقت tokensValidAfterTime للمستخدم المعنيّ. لا يتم تطبيق عملية التحقّق الإضافية هذه في حال عدم تحديدها. |
المرتجعات:
Promise<DecodedIdToken>
وعد يتم الوفاء به من خلال المطالبات التي تم فك ترميزها الخاصة بالرمز المميّز إذا كان الرمز المميّز صالحًا وعدًا مرفوضًا.
TenantAwareAuth.verifySessionCookie()
التحقّق من ملف تعريف ارتباط جلسة Firebase يعرض تعهدًا بالمطالبات بملكية ملفات تعريف الارتباط. يرفض الوعد في حال تعذّر التحقق من ملف تعريف الارتباط.
إذا تم ضبط checkRevoked على "صحيح"، يتحقّق أولاً مما إذا كان المستخدم المعني متوقفًا: إذا كانت الإجابة "نعم"، يتم عرض خطأ auth/user-disabled. إذا كانت الإجابة "لا"، يتم التحقّق مما إذا تم إبطال الجلسة المقابلة لملف تعريف الارتباط للجلسة. وإذا تم إبطال صلاحية جلسة المستخدم المقابلة، يتم عرض خطأ auth/session-cookie-revoked. إذا لم يتم تحديد هذه السمة، لن يتم إجراء الفحص.
راجِع التحقّق من ملفات تعريف ارتباط الجلسة للاطّلاع على عيّنات التعليمات البرمجية والمستندات التفصيلية.
Signature:
verifySessionCookie(sessionCookie: string, checkRevoked?: boolean): Promise<DecodedIdToken>;
المَعلمات
| المعلمة | النوع | الوصف |
|---|---|---|
| ملف تعريف الارتباط للجلسة | السلسلة | ملف تعريف الارتباط للجلسة المطلوب التحقّق منه. |
| تم إبطال علامة الاختيار | قيمة منطقية |
المرتجعات:
Promise<DecodedIdToken>
وعد يتم الوفاء به من خلال المطالبات التي تم فك ترميزها بملف تعريف ارتباط الجلسة إذا كان ملف تعريف الارتباط للجلسة صالحًا وعدًا مرفوضًا.