SAMLAuthProvider class

Dostawca uwierzytelniania dla SAML.

Podpis:

export declare class SAMLAuthProvider extends FederatedAuthProvider 

Rozszerza: FederatedAuthProvider

Konstruktorzy

Konstruktor Modyfikatory Opis
(konstruktor)(identyfikator dostawcy) Konstruktor. Identyfikator dostawcy musi zaczynać się od „saml”.

Metody

metoda Modyfikatory Opis
referencjaFromError(błąd) static Służy do wyodrębniania podstawowego OAuthCredential z błędu AuthError , który został zgłoszony podczas operacji logowania, łączenia lub ponownego uwierzytelniania.
dane uwierzytelniająceOdJSON(json) static Tworzy AuthCredential z ciągu JSON lub zwykłego obiektu.
dane uwierzytelniająceFromResult(poświadczenia użytkownika) static Generuje AuthCredential na podstawie UserCredential po pomyślnym zakończeniu przepływu SAML.

SAMLAuthProvider.(konstruktor)

Konstruktor. Identyfikator dostawcy musi zaczynać się od „saml”.

Podpis:

constructor(providerId: string);

Parametry

Parametr Typ Opis
identyfikator dostawcy strunowy Identyfikator dostawcy SAML.

SAMLAuthProvider.credentialFromError()

Służy do wyodrębniania podstawowego 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:

Poświadczenie uwierzytelnienia | zero

SAMLAuthProvider.credentialFromJSON()

Tworzy AuthCredential z ciągu JSON lub zwykłego obiektu.

Podpis:

static credentialFromJSON(json: string | object): AuthCredential;

Parametry

Parametr Typ Opis
json ciąg | obiekt Zwykły obiekt lub ciąg JSON

Zwroty:

Poświadczenie uwierzytelnienia

SAMLAuthProvider.credentialFromResult()

Generuje AuthCredential na podstawie UserCredential po pomyślnym zakończeniu przepływu SAML.

Na przykład, aby uzyskać AuthCredential , możesz napisać następujący kod:

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

Podpis:

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

Parametry

Parametr Typ Opis
Poświadczenie użytkownika Poświadczenia użytkownika Poświadczenia użytkownika.

Zwroty:

Poświadczenie uwierzytelnienia | zero