Um AuthProvider para SAML.
Assinatura:
export declare class SAMLAuthProvider extends FederatedAuthProvider
Estende: FederatedAuthProvider
Construtores
| Construtor | Modificadores | Descrição |
|---|---|---|
| (construtor)(providerId) | Construtor. O providerId precisa começar com "saml". |
Métodos
| Método | Modificadores | Descrição |
|---|---|---|
| credentialFromError(error) | static |
Usado para extrair a OAuthCredential subjacente de um AuthError gerado durante uma operação de login, link ou reautenticação. |
| credentialFromJSON(json) (link em inglês) | static |
Cria um AuthCredential usando uma string JSON ou um objeto simples. |
| credentialFromResult(userCredential) (link em inglês) | static |
Gera um AuthCredential de uma UserCredential após a conclusão de um fluxo SAML bem-sucedido. |
SAMLAuthProvider.(construtor)
Construtor. O providerId precisa começar com "saml".
Assinatura:
constructor(providerId: string);
Parâmetros
| Parâmetro | Tipo | Descrição |
|---|---|---|
| providerId | string | ID do provedor de SAML. |
SAMLAuthProvider.credentialFromError()
Usado para extrair a OAuthCredential subjacente de um AuthError gerado durante uma operação de login, link ou reautenticação.
Assinatura:
static credentialFromError(error: FirebaseError): AuthCredential | null;
Parâmetros
| Parâmetro | Tipo | Descrição |
|---|---|---|
| error | FirebaseError (em inglês) |
Retorna:
AuthCredential | nulo
SAMLAuthProvider.credentialFromJSON()
Cria um AuthCredential usando uma string JSON ou um objeto simples.
Assinatura:
static credentialFromJSON(json: string | object): AuthCredential;
Parâmetros
| Parâmetro | Tipo | Descrição |
|---|---|---|
| json | string | objeto | Um objeto simples ou uma string JSON |
Retorna:
AuthCredential (em inglês)
SAMLAuthProvider.credentialFromResult()
Gera um AuthCredential de uma UserCredential após a conclusão de um fluxo SAML bem-sucedido.
Por exemplo, para gerar uma AuthCredential, você pode escrever o seguinte código:
const userCredential = await signInWithPopup(auth, samlProvider);
const credential = SAMLAuthProvider.credentialFromResult(userCredential);
Assinatura:
static credentialFromResult(userCredential: UserCredential): AuthCredential | null;
Parâmetros
| Parâmetro | Tipo | Descrição |
|---|---|---|
| Credencialdeusuário | UserCredential (em inglês) | A credencial do usuário. |
Retorna:
AuthCredential | nulo