SAMLAuthProvider class

AuthProvider עבור SAML.

חֲתִימָה:

export declare class SAMLAuthProvider extends FederatedAuthProvider

מורחבת: FederatedAuthProvider

בונים

בַּנַאִי משנה תיאור
(קונסטרוקטור)(providerId) בַּנַאִי. ה-providerId חייב להתחיל ב-"saml".

שיטות

שיטה משנה תיאור
credentialFromError(שגיאה) static משמש לחילוץ ה- OAuthCredential הבסיסי מ- AuthError שנזרק במהלך פעולת כניסה, קישור או אימות מחדש.
credentialFromJSON(json) static יוצר AuthCredential ממחרוזת JSON או אובייקט רגיל.
credentialFromResult(userCredential) static יוצר AuthCredential מ- UserCredential לאחר השלמת זרימת SAML מוצלחת.

SAMLAuthProvider.(בנאי)

בַּנַאִי. ה-providerId חייב להתחיל ב-"saml".

חֲתִימָה:

constructor(providerId: string);

פרמטרים

פָּרָמֶטֶר סוּג תיאור
providerId חוּט מזהה ספק 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

החזרות:

AuthCredential

SAMLAuthProvider.credentialFromResult()

יוצר AuthCredential מ- UserCredential לאחר השלמת זרימת SAML מוצלחת.

לדוגמה, כדי לקבל AuthCredential , תוכל לכתוב את הקוד הבא:

const userCredential = await signInWithPopup(auth, samlProvider);
const credential = SAMLAuthProvider.credentialFromResult(userCredential);

חֲתִימָה:

static credentialFromResult(userCredential: UserCredential): AuthCredential | null;

פרמטרים

פָּרָמֶטֶר סוּג תיאור
UserCredential תעודת משתמש תעודת המשתמש.

החזרות:

AuthCredential | ריק