SAMLAuthProvider class

Поставщик аутентификации для SAML.

Подпись:

export declare class SAMLAuthProvider extends FederatedAuthProvider

Расширяет: FederatedAuthProvider

Конструкторы

Конструктор Модификаторы Описание
(конструктор) (идентификатор поставщика) Конструктор. Идентификатор поставщика должен начинаться с «saml».

Методы

Метод Модификаторы Описание
credentialFromError (ошибка) static Используется для извлечения базового OAuthCredential из ошибки AuthError , возникшей во время операции входа, установления соединения или повторной аутентификации.
учетные данныеFromJSON (json) static Создает AuthCredential из строки JSON или простого объекта.
credentialFromResult (userCredential) static Создает AuthCredential из UserCredential после успешного завершения потока SAML.

SAMLAuthProvider.(конструктор)

Конструктор. Идентификатор поставщика должен начинаться с «saml».

Подпись:

constructor(providerId: string);

Параметры

Параметр Тип Описание
идентификатор поставщика нить Идентификатор поставщика SAML.

SAMLAuthProvider.credentialFromError()

Используется для извлечения базового OAuthCredential из ошибки AuthError , возникшей во время операции входа, установления соединения или повторной аутентификации.

Подпись:

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

Параметры

Параметр Тип Описание
ошибка FirebaseError

Возврат:

Авторизация | нулевой

SAMLAuthProvider.credentialFromJSON()

Создает AuthCredential из строки JSON или простого объекта.

Подпись:

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

Параметры

Параметр Тип Описание
JSON строка | объект Простой объект или строка JSON.

Возврат:

Ауткредентиал

SAMLAuthProvider.credentialFromResult()

Создает AuthCredential из UserCredential после успешного завершения потока SAML.

Например, чтобы получить AuthCredential , вы можете написать следующий код:

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

Подпись:

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

Параметры

Параметр Тип Описание
userCredential Учетные данные пользователя Учетные данные пользователя.

Возврат:

Авторизация | нулевой