SAMLAuthProvider class

AuthProvider untuk SAML.

Tanda Tangan:

export declare class SAMLAuthProvider extends FederatedAuthProvider

Memperluas: FederatedAuthProvider

Konstruktor

Konstruktor Pengubah Deskripsi
(konstruktor)(providerId) Konstruktor. providerId harus diawali dengan "SAML."

Metode

Metode Pengubah Deskripsi
credentialFromError(error) static Digunakan untuk mengekstrak OAuthCredential yang mendasarinya dari AuthError yang ditampilkan selama operasi login, penautan, atau autentikasi ulang.
credentialFromJSON(json) static Membuat AuthCredential dari string JSON atau objek biasa.
credentialFromResult(userCredential) static Menghasilkan AuthCredential dari UserCredential setelah alur SAML berhasil diselesaikan.

SAMLAuthProvider.(konstruktor)

Konstruktor. providerId harus diawali dengan "SAML."

Tanda Tangan:

constructor(providerId: string);

Parameter

Parameter Jenis Deskripsi
providerId string ID penyedia SAML.

SAMLAuthProvider.credentialFromError()

Digunakan untuk mengekstrak OAuthCredential yang mendasarinya dari AuthError yang ditampilkan selama operasi login, penautan, atau autentikasi ulang.

Tanda Tangan:

static credentialFromError(error: FirebaseError): AuthCredential | null;

Parameter

Parameter Jenis Deskripsi
error FirebaseError

Hasil:

AuthCredential | null (kosong)

SAMLAuthProvider.credentialFromJSON()

Membuat AuthCredential dari string JSON atau objek biasa.

Tanda Tangan:

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

Parameter

Parameter Jenis Deskripsi
json rangkaian | objek Objek biasa atau string JSON

Hasil:

AuthCredential

SAMLAuthProvider.credentialFromResult()

Menghasilkan AuthCredential dari UserCredential setelah alur SAML berhasil diselesaikan.

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 Deskripsi
kredensialpengguna Kredensial Pengguna Kredensial pengguna.

Hasil:

AuthCredential | null (kosong)