voluptasmollitia
Version:
Monorepo for the Firebase JavaScript SDK
30 lines (19 loc) • 1.45 kB
Markdown
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) > [@firebase/auth](./auth.md) > [SAMLAuthProvider](./auth.samlauthprovider.md)
## SAMLAuthProvider class
An AuthProvider for SAML.
<b>Signature:</b>
```typescript
export declare class SAMLAuthProvider extends FederatedAuthProvider
```
<b>Extends:</b> FederatedAuthProvider
## Constructors
| Constructor | Modifiers | Description |
| --- | --- | --- |
| [(constructor)(providerId)](./auth.samlauthprovider._constructor_.md) | | Constructor. The providerId must start with "saml." |
## Methods
| Method | Modifiers | Description |
| --- | --- | --- |
| [credentialFromError(error)](./auth.samlauthprovider.credentialfromerror.md) | <code>static</code> | Used to extract the underlying [OAuthCredential](./auth.oauthcredential.md) from a [AuthError](./auth.autherror.md) which was thrown during a sign-in, link, or reauthenticate operation. |
| [credentialFromJSON(json)](./auth.samlauthprovider.credentialfromjson.md) | <code>static</code> | Creates an [AuthCredential](./auth.authcredential.md) from a JSON string or a plain object. |
| [credentialFromResult(userCredential)](./auth.samlauthprovider.credentialfromresult.md) | <code>static</code> | Generates an [AuthCredential](./auth.authcredential.md) from a [UserCredential](./auth.usercredential.md) after a successful SAML flow completes. |