Ein AuthProvider für SAML.
Unterschrift:
export declare class SAMLAuthProvider extends FederatedAuthProvider
Erweitert: FederatedAuthProvider
Konstrukteure
| Konstrukteur | Modifikatoren | Beschreibung |
|---|---|---|
| (Konstruktor)(ProviderId) | Konstrukteur. Die Provider-ID muss mit „saml“ beginnen. |
Methoden
| Methode | Modifikatoren | Beschreibung |
|---|---|---|
| credentialFromError(error) | static | Wird verwendet, um das zugrunde liegende OAuthCredential aus einem AuthError zu extrahieren, der während einer Anmelde-, Verknüpfungs- oder Neuauthentifizierungsoperation ausgelöst wurde. |
| credentialFromJSON(json) | static | Erstellt ein AuthCredential aus einer JSON-Zeichenfolge oder einem einfachen Objekt. |
| credentialFromResult(userCredential) | static | Generiert ein AuthCredential aus einem UserCredential , nachdem ein erfolgreicher SAML-Fluss abgeschlossen ist. |
SAMLAuthProvider.(Konstruktor)
Konstrukteur. Die Provider-ID muss mit „saml“ beginnen.
Unterschrift:
constructor(providerId: string);
Parameter
| Parameter | Typ | Beschreibung |
|---|---|---|
| Anbieter-ID | Zeichenfolge | SAML-Anbieter-ID. |
SAMLAuthProvider.credentialFromError()
Wird verwendet, um das zugrunde liegende OAuthCredential aus einem AuthError zu extrahieren, der während einer Anmelde-, Verknüpfungs- oder Neuauthentifizierungsoperation ausgelöst wurde.
Unterschrift:
static credentialFromError(error: FirebaseError): AuthCredential | null;
Parameter
| Parameter | Typ | Beschreibung |
|---|---|---|
| Fehler | FirebaseError |
Kehrt zurück:
AuthCredential | Null
SAMLAuthProvider.credentialFromJSON()
Erstellt ein AuthCredential aus einer JSON-Zeichenfolge oder einem einfachen Objekt.
Unterschrift:
static credentialFromJSON(json: string | object): AuthCredential;
Parameter
| Parameter | Typ | Beschreibung |
|---|---|---|
| json | Zeichenfolge | Objekt | Ein einfaches Objekt oder eine JSON-Zeichenfolge |
Kehrt zurück:
SAMLAuthProvider.credentialFromResult()
Generiert ein AuthCredential aus einem UserCredential , nachdem ein erfolgreicher SAML-Fluss abgeschlossen ist.
Zum Beispiel, um ein AuthCredential zu erhalten , könnten Sie den folgenden Code schreiben:
const userCredential = await signInWithPopup(auth, samlProvider);
const credential = SAMLAuthProvider.credentialFromResult(userCredential);
Unterschrift:
static credentialFromResult(userCredential: UserCredential): AuthCredential | null;
Parameter
| Parameter | Typ | Beschreibung |
|---|---|---|
| userCredential | Benutzeranmeldeinformationen | Die Benutzeranmeldeinformationen. |
Kehrt zurück:
AuthCredential | Null