TenantAwareAuth class

رابط Auth آگاه برای مدیریت کاربران، پیکربندی ارائه دهندگان SAML/OIDC، ایجاد پیوندهای ایمیل برای بازنشانی رمز عبور، تأیید ایمیل، و غیره برای مستاجران خاص.

پشتیبانی چند اجاره ای به پلتفرم هویت Google Cloud (GCIP) نیاز دارد. برای کسب اطلاعات بیشتر درباره GCIP، از جمله قیمت و ویژگی‌ها، به مستندات GCIP مراجعه کنید .

هر مستاجر شامل ارائه دهندگان هویت، تنظیمات و مجموعه‌ای از کاربران است. با استفاده از TenantAwareAuth کاربران برای یک مستاجر خاص و پیکربندی‌های OIDC/SAML مربوطه را نیز می‌توان مدیریت کرد، نشانه‌های شناسه برای کاربرانی که وارد یک مستاجر خاص شده‌اند را می‌توان تأیید کرد، و پیوندهای اقدام ایمیل را نیز می‌توان برای کاربران متعلق به مستاجر ایجاد کرد.

نمونه‌های TenantAwareAuth برای یک tenantId خاص می‌توانند با فراخوانی TenantManager.authForTenant () نمونه‌سازی شوند. .

امضا:

export declare class TenantAwareAuth extends BaseAuth 

گسترش می یابد: BaseAuth

خواص

ویژگی	اصلاح کننده ها	تایپ کنید	شرح
شناسه مستاجر		رشته	شناسه مستاجر مربوط به این نمونه TenantAwareAuth . همه تماس‌ها با APIهای مدیریت کاربر، APIهای مدیریت ارائه‌دهنده OIDC/SAML، APIهای ایجاد پیوند ایمیل و غیره فقط در محدوده این مستاجر اعمال می‌شوند.

مواد و روش ها

روش	اصلاح کننده ها	شرح
createSessionCookie (idToken، sessionCookieOptions)		یک کوکی جلسه Firebase جدید با گزینه های مشخص شده ایجاد می کند. رشته JWT ایجاد شده را می توان به عنوان کوکی جلسه سمت سرور با خط مشی کوکی سفارشی تنظیم کرد و برای مدیریت جلسه استفاده کرد. کوکی جلسه JWT دارای همان ادعای باربری است که توکن ID ارائه شده دارد. برای نمونه کد و مستندات دقیق به مدیریت کوکی‌های جلسه مراجعه کنید.
verifyIdToken(idToken، check Revoked)		یک نشانه Firebase ID (JWT) را تأیید می کند. اگر نشانه معتبر باشد، وعده با ادعاهای رمزگشایی شده محقق می شود. در غیر این صورت قول مردود است. اگر checkRevoked روی true تنظیم شده باشد، ابتدا بررسی کنید که آیا کاربر مربوطه غیرفعال است یا خیر. اگر بله، خطای auth/user-disabled داده می شود. اگر نه، بررسی می‌کند که آیا جلسه مربوط به کد ID لغو شده است یا خیر. اگر جلسه کاربر مربوطه باطل شد، یک خطای auth/id-token-revoked داده می‌شود. اگر مشخص نشده باشد چک اعمال نمی شود. برای نمونه کد و مستندات دقیق، به تأیید شناسه توکن‌ها مراجعه کنید.
verifySessionCookie(sessionCookie، check Revoked)		یک کوکی جلسه Firebase را تأیید می کند. یک قول را با ادعاهای کوکی برمی گرداند. اگر کوکی تأیید نشد، قول را رد می کند. اگر checkRevoked روی true تنظیم شده باشد، ابتدا بررسی کنید که آیا کاربر مربوطه غیرفعال است یا خیر: اگر بله، یک خطای auth/user-disabled داده می شود. اگر نه، بررسی می‌کند که آیا جلسه مربوط به کوکی جلسه لغو شده است یا خیر. اگر جلسه کاربر مربوطه باطل شد، یک خطای auth/session-cookie-revoked پرتاب می‌شود. اگر مشخص نشده باشد بررسی انجام نمی شود. برای نمونه کد و مستندات دقیق به تأیید کوکی‌های جلسه مراجعه کنید

TenantAwareAuth.tenantId

شناسه مستاجر مربوط به این نمونه TenantAwareAuth . همه تماس‌ها با APIهای مدیریت کاربر، APIهای مدیریت ارائه‌دهنده OIDC/SAML، APIهای ایجاد پیوند ایمیل و غیره فقط در محدوده این مستاجر اعمال می‌شوند.

امضا:

readonly tenantId: string;

TenantAwareAuth.createSessionCookie()

یک کوکی جلسه Firebase جدید با گزینه های مشخص شده ایجاد می کند. رشته JWT ایجاد شده را می توان به عنوان کوکی جلسه سمت سرور با خط مشی کوکی سفارشی تنظیم کرد و برای مدیریت جلسه استفاده کرد. کوکی جلسه JWT دارای همان ادعای باربری است که توکن ID ارائه شده دارد.

برای نمونه کد و مستندات دقیق به مدیریت کوکی‌های جلسه مراجعه کنید.

امضا:

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

مولفه های

پارامتر	تایپ کنید	شرح
idToken	رشته	کد Firebase ID برای مبادله با کوکی جلسه.
sessionCookieOptions	SessionCookieOptions	گزینه های کوکی جلسه که شامل مدت زمان جلسه سفارشی می شود.

برمی گرداند:

قول<رشته>

وعده ای که با موفقیت با کوکی جلسه ایجاد شده حل می شود.

TenantAwareAuth.verifyIdToken()

یک نشانه Firebase ID (JWT) را تأیید می کند. اگر نشانه معتبر باشد، وعده با ادعاهای رمزگشایی شده محقق می شود. در غیر این صورت قول مردود است.

اگر checkRevoked روی true تنظیم شده باشد، ابتدا بررسی کنید که آیا کاربر مربوطه غیرفعال است یا خیر. اگر بله، خطای auth/user-disabled داده می شود. اگر نه، بررسی می‌کند که آیا جلسه مربوط به کد ID لغو شده است یا خیر. اگر جلسه کاربر مربوطه باطل شد، یک خطای auth/id-token-revoked داده می‌شود. اگر مشخص نشده باشد چک اعمال نمی شود.

برای نمونه کد و مستندات دقیق، به تأیید شناسه توکن‌ها مراجعه کنید.

امضا:

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

مولفه های

پارامتر	تایپ کنید	شرح
idToken	رشته	رمز شناسایی برای تأیید.
چک لغو شد	بولی	بررسی اینکه آیا رمز شناسایی باطل شده است یا خیر. این نیاز به یک درخواست اضافی به باطن Firebase Auth برای بررسی زمان tokensValidAfterTime برای کاربر مربوطه دارد. وقتی مشخص نیست، این بررسی اضافی اعمال نمی شود.

برمی گرداند:

Promise< DecodedIdToken >

وعده ای که با ادعاهای رمزگشایی شده در صورت معتبر بودن رمز شناسه انجام می شود. در غیر این صورت قول رد شده

TenantAwareAuth.verifySessionCookie()

یک کوکی جلسه Firebase را تأیید می کند. یک قول را با ادعاهای کوکی برمی گرداند. اگر کوکی تأیید نشد، قول را رد می کند.

اگر checkRevoked روی true تنظیم شده باشد، ابتدا بررسی کنید که آیا کاربر مربوطه غیرفعال است یا خیر: اگر بله، یک خطای auth/user-disabled داده می شود. اگر نه، بررسی می‌کند که آیا جلسه مربوط به کوکی جلسه لغو شده است یا خیر. اگر جلسه کاربر مربوطه باطل شد، یک خطای auth/session-cookie-revoked پرتاب می‌شود. اگر مشخص نشده باشد بررسی انجام نمی شود.

برای نمونه کد و مستندات دقیق به تأیید کوکی‌های جلسه مراجعه کنید

امضا:

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

مولفه های

پارامتر	تایپ کنید	شرح
sessionCookie	رشته	کوکی جلسه برای تأیید.
چک لغو شد	بولی

برمی گرداند:

Promise< DecodedIdToken >

وعده ای که با ادعاهای رمزگشایی شده کوکی جلسه در صورت معتبر بودن کوکی جلسه محقق می شود. در غیر این صورت قول رد شده