AuthProvider dla SAML.
Podpis:
export declare class SAMLAuthProvider extends FederatedAuthProvider
Rozszerza: FederatedAuthProvider
Zespoły
| Zespół | Modyfikatory | Opis |
|---|---|---|
| (constructor)(providerId) | Konstruktor. Identyfikator dostawcy musi zaczynać się od „saml”. |
Metody
| Metoda | Modyfikatory | Opis |
|---|---|---|
| credentialFromError(błąd) | static |
Służy do wyodrębniania bazowych danych OAuthCredential z błędu AuthError, który został zgłoszony podczas operacji logowania, łączenia lub ponownego uwierzytelniania. |
| credentialFromJSON(json) | static |
Tworzy AuthCredential z ciągu znaków JSON lub zwykłego obiektu. |
| credentialFromResult(Dane logowania użytkownika) | static |
Generuje AuthCredential z parametru UserCredential po pomyślnym zakończeniu procesu SAML. |
SAMLAuthProvider.(konstruktor)
Konstruktor. Identyfikator dostawcy musi zaczynać się od „saml”.
Podpis:
constructor(providerId: string);
Parametry
| Parametr | Typ | Opis |
|---|---|---|
| Identyfikator dostawcy | ciąg znaków | Identyfikator dostawcy SAML. |
SAMLAuthProvider.credentialFromError()
Służy do wyodrębniania bazowych danych OAuthCredential z błędu AuthError, który został zgłoszony podczas operacji logowania, łączenia lub ponownego uwierzytelniania.
Podpis:
static credentialFromError(error: FirebaseError): AuthCredential | null;
Parametry
| Parametr | Typ | Opis |
|---|---|---|
| błąd | Błąd Firebase |
Zwroty:
AuthCredential | wartość null
SAMLAuthProvider.credentialFromJSON()
Tworzy AuthCredential z ciągu znaków JSON lub zwykłego obiektu.
Podpis:
static credentialFromJSON(json: string | object): AuthCredential;
Parametry
| Parametr | Typ | Opis |
|---|---|---|
| JSON | ciąg znaków | obiekt | Zwykły obiekt lub ciąg JSON |
Zwroty:
AuthCredential (Dane uwierzytelniające)
SAMLAuthProvider.credentialFromResult()
Generuje AuthCredential z parametru UserCredential po pomyślnym zakończeniu procesu SAML.
Aby na przykład uzyskać AuthCredential, możesz napisać taki kod:
const userCredential = await signInWithPopup(auth, samlProvider);
const credential = SAMLAuthProvider.credentialFromResult(userCredential);
Podpis:
static credentialFromResult(userCredential: UserCredential): AuthCredential | null;
Parametry
| Parametr | Typ | Opis |
|---|---|---|
| userCredential | UserCredential (Dane logowania użytkownika) | Dane logowania użytkownika. |
Zwroty:
AuthCredential | wartość null