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