Penyedia Auth untuk SAML.
Tanda tangan:
export declare class SAMLAuthProvider extends FederatedAuthProvider
Perluasan: FederatedAuthProvider
Konstruktor
Konstruktor | Pengubah | Keterangan |
---|---|---|
(konstruktor)(providerId) | Konstruktor. ProviderId harus dimulai dengan "saml." |
Metode
metode | Pengubah | Keterangan |
---|---|---|
credentialFromError(kesalahan) | static | Digunakan untuk mengekstrak OAuthCredential yang mendasarinya dari AuthError yang muncul selama operasi masuk, menautkan, atau mengautentikasi ulang. |
kredensialDariJSON(json) | static | Membuat AuthCredential dari string JSON atau objek biasa. |
credentialFromResult(penggunaCredential) | static | Menghasilkan AuthCredential dari UserCredential setelah alur SAML yang berhasil selesai. |
SAMLAuthProvider.(konstruktor)
Konstruktor. ProviderId harus dimulai dengan "saml."
Tanda tangan:
constructor(providerId: string);
Parameter
Parameter | Jenis | Keterangan |
---|---|---|
penyediaId | rangkaian | ID penyedia SAML. |
SAMLAuthProvider.credentialFromError()
Digunakan untuk mengekstrak OAuthCredential yang mendasarinya dari AuthError yang muncul selama operasi masuk, menautkan, atau mengautentikasi ulang.
Tanda tangan:
static credentialFromError(error: FirebaseError): AuthCredential | null;
Parameter
Parameter | Jenis | Keterangan |
---|---|---|
kesalahan | Kesalahan Firebase |
Pengembalian:
Kredensial Auth | batal
SAMLAuthProvider.credentialFromJSON()
Membuat AuthCredential dari string JSON atau objek biasa.
Tanda tangan:
static credentialFromJSON(json: string | object): AuthCredential;
Parameter
Parameter | Jenis | Keterangan |
---|---|---|
json | tali | obyek | Objek biasa atau string JSON |
Pengembalian:
SAMLAuthProvider.credentialFromResult()
Menghasilkan AuthCredential dari UserCredential setelah alur SAML yang berhasil selesai.
Misalnya, untuk mendapatkan AuthCredential , Anda dapat menulis kode berikut:
const userCredential = await signInWithPopup(auth, samlProvider);
const credential = SAMLAuthProvider.credentialFromResult(userCredential);
Tanda tangan:
static credentialFromResult(userCredential: UserCredential): AuthCredential | null;
Parameter
Parameter | Jenis | Keterangan |
---|---|---|
Kredensial pengguna | Kredensial Pengguna | Kredensial pengguna. |
Pengembalian:
Kredensial Auth | batal