یک Auth Provider برای SAML.
امضا:
export declare class SAMLAuthProvider extends FederatedAuthProvider
گسترش می یابد: FederatedAuthProvider
سازندگان
| سازنده | اصلاح کننده ها | شرح |
|---|---|---|
| (سازنده) (ProviderId) | سازنده. شناسه ارائه دهنده باید با "saml" شروع شود. |
مواد و روش ها
| روش | اصلاح کننده ها | شرح |
|---|---|---|
| credentialFromError (خطا) | static | برای استخراج OAuthCredential زیربنایی از AuthError که در طی یک عملیات ورود به سیستم، پیوند، یا احراز هویت مجدد پرتاب شده است استفاده می شود. |
| credentialFromJSON(json) | static | یک AuthCredential از یک رشته JSON یا یک شی ساده ایجاد می کند. |
| credentialFromResult(userCredential) | static | پس از اتمام یک جریان SAML موفقیت آمیز، یک اعتبار اعتبار از یک UserCredential ایجاد می کند. |
SAMLAuthProvider.(سازنده)
سازنده. شناسه ارائه دهنده باید با "saml" شروع شود.
امضا:
constructor(providerId: string);
مولفه های
| پارامتر | تایپ کنید | شرح |
|---|---|---|
| شناسه ارائه دهنده | رشته | شناسه ارائه دهنده SAML. |
SAMLAuthProvider.credentialFromError()
برای استخراج OAuthCredential زیربنایی از AuthError که در طی یک عملیات ورود به سیستم، پیوند، یا احراز هویت مجدد پرتاب شده است استفاده می شود.
امضا:
static credentialFromError(error: FirebaseError): AuthCredential | null;
مولفه های
| پارامتر | تایپ کنید | شرح |
|---|---|---|
| خطا | FirebaseError |
برمی گرداند:
AuthCredential | خالی
SAMLAuthProvider.credentialFromJSON()
یک AuthCredential از یک رشته JSON یا یک شی ساده ایجاد می کند.
امضا:
static credentialFromJSON(json: string | object): AuthCredential;
مولفه های
| پارامتر | تایپ کنید | شرح |
|---|---|---|
| json | رشته | هدف - شی | یک شی ساده یا یک رشته JSON |
برمی گرداند:
SAMLAuthProvider.credentialFromResult()
پس از اتمام یک جریان SAML موفقیت آمیز، یک اعتبار اعتبار از یک UserCredential ایجاد می کند.
به عنوان مثال، برای دریافت AuthCredential ، می توانید کد زیر را بنویسید:
const userCredential = await signInWithPopup(auth, samlProvider);
const credential = SAMLAuthProvider.credentialFromResult(userCredential);
امضا:
static credentialFromResult(userCredential: UserCredential): AuthCredential | null;
مولفه های
| پارامتر | تایپ کنید | شرح |
|---|---|---|
| اعتبار کاربری | اعتبار کاربری | اعتبار کاربری |
برمی گرداند:
AuthCredential | خالی