![](\"demo/screenshot.png\" "\\"Screenshot\\"")
\n\n \n
| Name | \nRequired | \nDescription | \n
|---|---|---|
| autoUpgradeAnonymousUsers | \nNo | \n\n Whether to automatically upgrade existing anonymous users on sign-in/sign-up.\n See Upgrading anonymous users.\n \n Default:\n false\n When set to true, signInFailure callback is\n required to be provided to handle merge conflicts.\n | \n
| callbacks | \nNo | \n\n An object of developers callbacks after\n specific events.\n \n Default: {}\n | \n
| credentialHelper | \nNo | \n\n The Credential Helper to use.\n See Credential Helper.\n \n Default:\n firebaseui.auth.CredentialHelper.NONE\n | \n
| queryParameterForSignInSuccessUrl | \nNo | \n\n The redirect URL parameter name for the sign-in success URL. See\n Overwriting the sign-in success URL.\n \n Default: \"signInSuccessUrl\"\n | \n
| queryParameterForWidgetMode | \nNo | \n\n The redirect URL parameter name for the “mode” of the Widget.\n See FirebaseUI widget modes.\n \n Default: \"mode\"\n | \n
| signInFlow | \nNo | \n\n The sign-in flow to use for IDP providers: redirect or\n popup.\n \n Default: \"redirect\"\n | \n
| immediateFederatedRedirect | \nNo | \n\n A boolean which determines whether to immediately redirect to the provider's\n site or instead show the default 'Sign in with Provider' button when there is\n only a single federated provider in signInOptions. In order for\n this option to take effect, the signInOptions must only hold a\n single federated provider (like 'google.com') and signInFlow must be set to\n 'redirect'.\n | \n
| signInOptions | \nYes | \n\n The list of providers enabled for signing\n into your app. The order you specify them will be the order they are displayed\n on the sign-in provider selection screen.\n | \n
| signInSuccessUrl | \nNo | \n\n The URL where to redirect the user after a successful sign-in.\n Required when the signInSuccessWithAuthResult\n callback is not used or when it returns true.\n | \n
| tosUrl | \nYes | \n\n The URL of the Terms of Service page or a callback function to be invoked\n when Terms of Service link is clicked.\n | \n
| privacyPolicyUrl | \nYes | \n\n The URL of the Privacy Policy page or a callback function to be invoked\n when Privacy Policy link is clicked.\n | \n
| adminRestrictedOperation | \nNo | \n\n This setting is only applicable to \"Google Cloud Identity Platform\" projects.\n Learn more about [GCIP](https://cloud.google.com/identity-platform/).\n The object for configuring `adminRestrictedOperation` options, contains 3\n fields:\n `status(boolean)`: This flag should mirror the project user actions\n (\"Enable create\") settings. When sign-up is disabled in the project settings,\n this should be set to `true`. Setting this to `true` without disabling sign-up\n in the project settings will not have any effect. For GCIP projects, this is\n done by going to the \"Settings\" page in the \"Identity Platform\" section in the\n Cloud Console. Under the \"USERS\" tab, go to \"User actions\". Uncheck \"Enable\n create (sign-up)\" and click \"SAVE\".\n This does not enforce the policy but is rather useful for providing additional\n instructions to the end user when a user tries to create a new user account\n and the Auth server blocks the operation. This boolean works on all providers\n (federated, email/password, email link and phone number).\n `adminEmail(string|undefined)`: The optional site administrator email to\n contact for access when sign up is disabled, for example: `admin@example.com`.\n `helpLink(string|undefined)`: The optional help link to provide information\n on how to get access to the site when sign up is disabled. For example:\n `https://www.example.com/trouble_signing_in`.\n | \n
| Name | \nRequired | \nDescription | \n
|---|---|---|
| provider | \nYes | \nThe provider ID, eg. microsoft.com. | \n
| providerName | \nNo | \n\n The provider name displayed to end users (sign in button/linking prompt),\n eg. \"Microsoft\"\n Default:\n provider ID\n | \n
| fullLabel | \nNo | \n\n The full label of the button. Instead of \"Sign in with $providerName\", this\n button label will be used.\n Default:\n Sign in with $providerName\n | \n
| buttonColor | \nNo | \n\n The color of sign in button. The css of the button can be overwritten with\n the attribute/value in the HTML element:\n data-provider-id=\"providerId\"\n | \n
| iconUrl | \nNo | \n\n The URL of the Identity Provider's icon. This will be displayed on the\n provider's sign-in button, etc.\n | \n
| scopes | \nNo | \n\n The list of additional OAuth 2.0 scopes beyond basic profile that you want to\n request from the authentication provider.\n | \n
| customParameters | \nNo | \n\n The list of additional custom OAuth parameters that you want to send with the\n OAuth request.\n | \n
| loginHintKey | \nNo | \n\n The key of the custom parameter, with which the login hint can be passed to\n the provider. This is useful in case a user previously signs up with an IdP\n like Microsoft and then tries to sign in with email using the same Microsoft\n email. FirebaseUI can then ask the user to sign in with that email to the\n already registered account with Microsoft. For Microsoft and Yahoo,\n this field is `login_hint`.\n | \n
| Name | \nRequired | \nDescription | \n
|---|---|---|
| provider | \nYes | \nThe provider ID, eg. oidc.myProvider. | \n
| providerName | \nNo | \n\n The provider name displayed to end users (sign in button/linking prompt).\n Default:\n provider ID\n | \n
| fullLabel | \nNo | \n\n The full label of the button. Instead of \"Sign in with $providerName\", this\n button label will be used.\n Default:\n Sign in with $providerName\n | \n
| buttonColor | \nYes | \n\n The color of sign in button. The css of the button can be overwritten with\n attribute/value in the HTML element:\n data-provider-id=\"providerId\"\n | \n
| iconUrl | \nYes | \n\n The URL of the Identity Provider's icon. This will be displayed on the\n provider's sign-in button, etc.\n | \n
| customParameters | \nNo | \n\n The list of additional custom parameters that the OIDC provider supports.\n | \n
| Name | \nRequired | \nDescription | \n
|---|---|---|
| provider | \nYes | \nThe provider ID, eg. saml.myProvider. | \n
| providerName | \nNo | \n\n The provider name displayed to end users (sign in button/linking prompt).\n Default:\n provider ID\n | \n
| fullLabel | \nNo | \n\n The full label of the button. Instead of \"Sign in with $providerName\", this\n button label will be used.\n Default:\n Sign in with $providerName\n | \n
| buttonColor | \nYes | \n\n The color of sign in button. The css of the button can be overwritten with\n attribute/value in the HTML element:\n data-provider-id=\"providerId\"\n | \n
| iconUrl | \nYes | \n\n The URL of the Identity Provider's icon. This will be displayed on the\n provider's sign-in button, etc.\n | \n
signInOptions\narray.\n\nYou can disable new user sign up with email providers by setting the flag\n`disableSignUp.status` to `true`. This will display an error message when new\nusers attempt to sign up.\n\nNote that this flag will only disable sign up from the UI and will not prevent\nsign up via REST API. It is highly recommended that Identity Platform projects\nenforce this policy via one of these 2 mechanisms:\n\n- Blocking functions: Set a `beforeCreate` trigger to disable sign up for email\n providers.\n- In the Cloud Console / Settings / USERS tab, uncheck `Enable create (sign-up)`\n checkbox. Though for this setting, sign up for all providers will be disabled.\n\n| Name | \nType | \nRequired | \nDescription | \n
|---|---|---|---|
| provider | \nstring | \nYes | \n\n For email sign-in, this should be\n firebase.auth.EmailAuthProvider.PROVIDER_ID.\n | \n
| requireDisplayName | \nboolean | \nNo | \n\n Defines whether to require the user to provide a display name during email\n and password sign up.\n \n Default: true\n | \n
| signInMethod | \nstring | \nNo | \n\n Defines whether to use email and password or email link authentication.\n This should be\n firebase.auth.EmailAuthProvider.EMAIL_PASSWORD_SIGN_IN_METHOD\n for email and password sign-in,\n firebase.auth.EmailAuthProvider.EMAIL_LINK_SIGN_IN_METHOD for\n email link authentication.\n \n Default:\n firebase.auth.EmailAuthProvider.EMAIL_PASSWORD_SIGN_IN_METHOD\n | \n
| forceSameDevice | \nboolean | \nNo | \n\n Whether to force same device flow. If false, opening the link on a different\n device will display a message instructing the user to open the link on the\n same device or browser. This should be true when used with\n anonymous user upgrade flows. This is only relevant to email link sign-in.\n Default: false\n | \n
| emailLinkSignIn | \nfunction | \nNo | \n\n Defines the optional callback function to return\n firebase.auth.ActionCodeSettings configuration to use when\n sending the link. This provides the ability to specify how the link can be\n handled, custom dynamic link, additional state in the deep link, etc.\n When not provided, the current URL is used and a web only flow is triggered.\n This is only relevant to email link sign-in.\n | \n
| disableSignUp | \nfirebaseui.auth.DisableSignUpConfig | \nNo | \n\n The object for configuring `disableSignUp` options, contains 3 fields:\n `status(boolean)`: Whether disable user from signing up with email providers\n (email/password or email link).\n `adminEmail(string|undefined)`: The optional site administrator email to\n contact for access when sign up is disabled, for example: `admin@example.com`.\n `helpLink(string|undefined)`: The optional help link to provide information\n on how to get access to the site when sign up is disabled. For example:\n `https://www.example.com/trouble_signing_in`.\n | \n
url can be retrieved on sign-in\ncompletion via the signInSuccess callbacks.\n\nIf you are using a fragment in the URL, additional FirebaseUI parameters will be\nappended to the query string component instead of the fragment.\nSo for a url `https://www.example.com/#/signin`, the completion URL will take\nthe form `https://www.example.com/?uid_sid=xyz&ui_sd=0#/signin`.\nThis should be taken into account when using frameworks with \"hash routing\".\n\n```javascript\n// ...\nsignInSuccessWithAuthResult: function(authResult, redirectUrl) {\n // If a user signed in with email link, ?showPromo=1234 can be obtained from\n // window.location.href.\n // ...\n return false;\n}\n```\n\nFirebaseUI uses the\n[history API](https://developer.mozilla.org/en-US/docs/Web/API/History_API) to\nclear the URL from query parameters related to email link sign-in after the\none-time code is processed. This prevents the user from re-triggering the\nsign-in completion flow again on page reload or if the user signs out and tries\nto sign in again in a single page application, etc.\n\nWhen same device flows are not enforced, a user going through account linking\nflow (eg. user signing in with Facebook with an email that belongs to an\nexisting email link user) opening the link on a different device would be given\nthe choice to continue sign-in with email link without merging the Facebook\ncredential or instructed to open the link on the same device where the flow was\ninitiated to successfully merge both accounts.\n\nYou cannot use email/password and email/link sign-in at the same time. Only one\nmode can be configured at a time. However, if you previously signed up users\nwith passwords. Switching to email/link will only apply to new users and\nexisting password users will continue to be prompted for password on sign-in.\n\n### Configure Phone Provider\n\nThe `PhoneAuthProvider` can be configured with custom reCAPTCHA parameters\nwhether reCAPTCHA is visible or invisible (defaults to `normal`). Refer to the\n[reCAPTCHA API docs](https://developers.google.com/recaptcha/docs/display) for\nmore details.\n\nThe default country to select in the phone number input can also be set.\n[List of supported country codes](javascript/data/README.md). If unspecified,\nthe phone number input will default to the United States (+1).\n\nThe countries to select can also be configured with `blacklistedCountries` or\n`whitelistedCountries`. It accepts either ISO (alpha-2) or E164\n(prefix with '+') formatted country code. Invalid country code will be ignored.\n`whitelistedCountries` and `blacklistedCountries` cannot be specified at the\nsame time.\n\nThe following options are currently supported. Any other\nparameters will be ignored.\n\n```javascript\nui.start('#firebaseui-auth-container', {\n signInOptions: [\n {\n provider: firebase.auth.PhoneAuthProvider.PROVIDER_ID,\n recaptchaParameters: {\n type: 'image', // 'audio'\n size: 'normal', // 'invisible' or 'compact'\n badge: 'bottomleft' //' bottomright' or 'inline' applies to invisible.\n },\n defaultCountry: 'GB', // Set default country to the United Kingdom (+44).\n // For prefilling the national number, set defaultNationNumber.\n // This will only be observed if only phone Auth provider is used since\n // for multiple providers, the NASCAR screen will always render first\n // with a 'sign in with phone number' button.\n defaultNationalNumber: '1234567890',\n // You can also pass the full phone number string instead of the\n // 'defaultCountry' and 'defaultNationalNumber'. However, in this case,\n // the first country ID that matches the country code will be used to\n // populate the country selector. So for countries that share the same\n // country code, the selected country may not be the expected one.\n // In that case, pass the 'defaultCountry' instead to ensure the exact\n // country is selected. The 'defaultCountry' and 'defaultNationaNumber'\n // will always have higher priority than 'loginHint' which will be ignored\n // in their favor. In this case, the default country will be 'GB' even\n // though 'loginHint' specified the country code as '+1'.\n loginHint: '+11234567890',\n // You can provide a 'whitelistedCountries' or 'blacklistedCountries' for\n // countries to select. It takes an array of either ISO (alpha-2) or\n // E164 (prefix with '+') formatted country codes. If 'defaultCountry' is\n // not whitelisted or is blacklisted, the default country will be set to\n // the first country available (alphabetical order). Notice that\n // 'whitelistedCountries' and 'blacklistedCountries' cannot be specified\n // at the same time.\n whitelistedCountries: ['US', '+44']\n }\n ]\n});\n```\n\n### Configure Anonymous Provider\n\nThe `AnonymousAuthProvider` can be enabled to let users continue as a guest. If\na user is already signed in anonymously, clicking this sign-in option will keep\nthe same current anonymous user. In addition, when auto-upgrade for anonymous\nusers is enabled in addition to this option and a user is already signed in\nanonymously, clicking this sign-in option will also keep the same current\nanonymous user.\n\n```javascript\nui.start('#firebaseui-auth-container', {\n signInOptions: [\n {\n provider: firebaseui.auth.AnonymousAuthProvider.PROVIDER_ID\n }\n ]\n});\n```\n\n### Sign In Flows\n\nTwo sign in flows are available:\n\n- `redirect`, the default, will perform a full page redirect to the sign-in page\n of the provider (Google, Facebook...). This is recommended for mobile apps.\n- The `popup` flow will open a popup to the sign-in page of the provider. If the\n popup is blocked by the browser, it will fall back to a full page redirect.\n\n### Available callbacks\n\n#### `signInSuccessWithAuthResult(authResult, redirectUrl)`\n\nThe `signInSuccessWithAuthResult` callback is invoked when user signs in\nsuccessfully.\nThe authResult provided here is a `firebaseui.auth.AuthResult` object, which\nincludes the current logged in user, the credential used to sign in the user,\nadditional user info indicating if the user is new or existing and operation\ntype like 'signIn' or 'link'. This callback will replace `signInSuccess` in\nfuture.\n\n**Parameters:**\n\n|Name |Type | Optional|Description |\n|-------------|------------------------------|---------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n|`authResult`|`firebaseui.auth.AuthResult` |No |The AuthResult of successful sign-in operation. The AuthResult object has same signature as `firebase.auth.UserCredential`.|\n|`redirectUrl`|`string` |Yes |The URL where the user is redirected after the callback finishes. It will only be given if you [overwrite the sign-in success URL](#overwriting-the-sign-in-success-url).|\n\n**Should return: `boolean`**\n\nIf the callback returns `true`, then the page is automatically redirected\ndepending on the case:\n\n- If no `signInSuccessUrl` parameter was given in the URL (See:\n [Overwriting the sign-in success URL](#overwriting-the-sign-in-success-url))\n then the default `signInSuccessUrl` in config is used.\n- If the value is provided in the URL, that value will be used instead of the\n static `signInSuccessUrl` in config.\n\nIf the callback returns `false` or nothing, the page is not automatically\nredirected.\n\n#### `signInSuccess(currentUser, credential, redirectUrl)`\n\nThis callback will be deprecated and will be replaced by\n`signInSuccessWithAuthResult` which takes `firebaseui.auth.AuthResult`.\n\n**Parameters:**\n\n|Name |Type | Optional|Description |\n|-------------|------------------------------|---------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n|`currentUser`|`firebase.User` |No |The logged in user. |\n|`credential` |`firebase.auth.AuthCredential`|Yes |The credential used to sign in the user. |\n|`redirectUrl`|`string` |Yes |The URL where the user is redirected after the callback finishes. It will only be given if you [overwrite the sign-in success URL](#overwriting-the-sign-in-success-url).|\n\n**Should return: `boolean`**\n\nIf the callback returns `true`, then the page is automatically redirected\ndepending on the case:\n\n- If no `signInSuccessUrl` parameter was given in the URL (See:\n [Overwriting the sign-in success URL](#overwriting-the-sign-in-success-url))\n then the default `signInSuccessUrl` in config is used.\n- If the value is provided in the URL, that value will be used instead of the\n static `signInSuccessUrl` in config.\n\nIf the callback returns `false` or nothing, the page is not automatically\nredirected.\n\n#### `signInFailure(error)`\n\nThe `signInFailure` callback is provided to handle any unrecoverable error\nencountered during the sign-in process.\nThe error provided here is a `firebaseui.auth.AuthUIError` error with the\nfollowing properties.\n\n**firebaseui.auth.AuthUIError properties:**\n\n|Name |Type |Optional |Description |\n|---------|----------------|---------|-----------------------|\n|`code` |`string` |No |The corresponding error code. Currently the only error code supported is `firebaseui/anonymous-upgrade-merge-conflict` |\n|`credential` |`firebase.auth.AuthCredential`|Yes |The existing non-anonymous user credential the user tried to sign in with.|\n\n**Should return: `Promise