FusionAuth · escii · Apr 28, 2024 · Apr 29, 2024 · May 15, 2024 · May 15, 2024
@@ -5,6 +5,7 @@ import DeletingYourAccount from 'src/content/docs/_shared/_deleting-your-account
 import InlineField from 'src/components/InlineField.astro';
 import SettingUpPortalAccount from 'src/content/docs/get-started/_setting-up-portal-account.mdx';
 import SupportTicketsOpener from 'src/content/docs/get-started/download-and-install/_support-tickets-opener.mdx';
+import Breadcrumb from 'src/components/Breadcrumb.astro';
 
 ## Overview
 
@@ -135,7 +136,7 @@ You can change your company name.
 
 <img src="/img/docs/get-started/download-and-install/company-edit.png" alt="Edit your company." width="1200" role="bottom-cropped" />
 
-You can remove all your company details by navigating to the <strong>Company -> Danger zone</strong> section.
+You can remove all your company details by navigating to the <Breadcrumb>Company -> Danger zone</Breadcrumb> section.
 Follow the instructions there, including removing all your deployments, and you'll be able to remove all data about you and your company.
 
 <img src="/img/docs/get-started/download-and-install/company-danger-zone.png" alt="The company danger zone." width="1200" role="bottom-cropped" />

@@ -40,15 +40,15 @@ Non-production keys may be used for any other instances such as your developers'
 Create an API key you can use to manage FusionAuth in an emergency. If you lose access to the administrative user interface, you can use this API key to retain access to your FusionAuth instance by adding a new `admin` user.
 
 * Log in to the administrative user interface.
-* Navigate to <strong>Settings -> API Keys</strong>.
+* Navigate to <Breadcrumb>Settings -> API Keys</Breadcrumb>.
 * Add an API Key with no limitations. This will make it a super user key with no limitations.
 * Note the key value, and store it someplace safe.
 
 {/*  Is this duplicative of tutorials/setup-wizard/#complete-setup ? */}
 
 ## Modify the Tenant Issuer
 
-The <InlineField>Issuer</InlineField>, found by navigating to <strong>Tenants -> Your Tenant -> General</strong> defaults to `acme.com`. This is not usually what you want. 
+The <InlineField>Issuer</InlineField>, found by navigating to <Breadcrumb>Tenants -> Your Tenant -> General</Breadcrumb> defaults to `acme.com`. This is not usually what you want.
 
 This value is used by any JWTs created by the OAuth grants or the Login API.
 

@@ -2,6 +2,7 @@
 import APIBlock from 'src/components/api/APIBlock.astro';
 import APIField from 'src/components/api/APIField.astro';
 import InlineField from 'src/components/InlineField.astro';
+import Breadcrumb from 'src/components/Breadcrumb.astro';
 
 const { getStartedHref, getStartedText, idp, linkingStrategy, scopeDefault, scopeDescription } = Astro.props;
 ---
@@ -52,7 +53,7 @@ The only functional difference between these two APIs is that the public API is
   <APIField name="Reconcile lambda" optional>
     A lambda maps custom claims returned from {idp} to the FusionAuth User or Registration.
 
-    To create or configure a lambda, navigate to <strong>Customizations -> Lambdas</strong>. <a href="/docs/extend/code/lambdas/">See the lambda documentation for more</a>.
+    To create or configure a lambda, navigate to <Breadcrumb>Customizations -> Lambdas</Breadcrumb>. <a href="/docs/extend/code/lambdas/">See the lambda documentation for more</a>.
   </APIField>
 
   <APIField name="Debug enabled" optional defaults="false">

@@ -1,6 +1,7 @@
 ---
 import InlineField from "src/components/InlineField.astro";
 import LoginAPIWithFederationDiagram from 'src/diagrams/docs/get-started/core-concepts/integration-points/login-api-flow-federation.astro';
+import Breadcrumb from 'src/components/Breadcrumb.astro';
 
 const { apiRef } = Astro.props;
 
@@ -21,7 +22,7 @@ You might do this if you are using the <a href="/docs/apis/login">Login API</a>
 </p>
 
 <p>
-If you require a refresh token after completing the login, ensure <InlineField>Enable JWT Refresh</InlineField> is <code>true</code> in the application configuration. This is found in the administrative user interface by navigating to <strong>Applications -> Your Application -> Security -> Login API settings</strong>.
+If you require a refresh token after completing the login, ensure <InlineField>Enable JWT Refresh</InlineField> is <code>true</code> in the application configuration. This is found in the administrative user interface by navigating to <Breadcrumb>Applications -> Your Application -> Security -> Login API settings</Breadcrumb>.
 </p>
 
 
@@ -1,4 +1,5 @@
 import Aside from 'src/components/Aside.astro';
+import Breadcrumb from 'src/components/Breadcrumb.astro';
 
 <Aside type="caution">
 Reindexing is an expensive operation, especially if your system has a large number of users, so it should not be run unless necessary.
@@ -9,7 +10,7 @@ It is possible, though rare, for an Elasticsearch index to become out of sync wi
 In general, even if a temporary outage occurs with Elasticsearch, the index will be sync up automatically.
 
 
-If you do need to run this, navigate to <strong>System -> Reindex</strong> in the FusionAuth admin UI to initiate a reindex of all users. This navigation item will only be displayed when the search engine is Elasticsearch.
+If you do need to run this, navigate to <Breadcrumb>System -> Reindex</Breadcrumb> in the FusionAuth admin UI to initiate a reindex of all users. This navigation item will only be displayed when the search engine is Elasticsearch.
 
 Optionally, you can also reindex via API.
 

@@ -1,6 +1,7 @@
 import InlineField from 'src/components/InlineField.astro';
 import InlineUIElement from 'src/components/InlineUIElement.astro';
 import Aside from 'src/components/Aside.astro';
+import Breadcrumb from 'src/components/Breadcrumb.astro';
 
 The purpose of writing a custom password hasher is to import users into FusionAuth using an existing hashing scheme. This allows you to seamlessly import your users without requiring them to change their password. The downside of this approach is that you now have preserved a hash which may be weak. FusionAuth will continue to use that hash unless you rehash users' passwords. 
 
@@ -11,7 +12,7 @@ To import users and transparently rehash their passwords, do the following:
 * Write a custom password hasher.
 * Import user passwords, setting the scheme for each user to the custom password hasher.
 * Decide on the new hashing scheme you want to use.
-* In the administrative user interface, navigate to <strong>Tenants -> Your Tenant -> Password</strong> and then to the <strong>Cryptographic hash settings</strong> section. Here you will configure both the new scheme and the rehash on login behavior.
+* In the administrative user interface, navigate to <Breadcrumb>Tenants -> Your Tenant -> Password</Breadcrumb> and then to the <Breadcrumb>Cryptographic hash settings</Breadcrumb> section. Here you will configure both the new scheme and the rehash on login behavior.
 * Configure the tenant to use the new hashing scheme by selecting it. You may use one of the standard hashing schemes or a different custom scheme. This will be used for all new users in this tenant as well.
 * Configure the tenant to rehash on login by checking the <InlineField>Re-hash on login</InlineField> checkbox.
 * Save the tenant configuration.

@@ -1,5 +1,6 @@
 import APIField from 'src/components/api/APIField.astro';
 import InlineField from 'src/components/InlineField.astro';
+import Breadcrumb from 'src/components/Breadcrumb.astro';
 
 <APIField name="pendingIdPLinkId" type="String" since="1.28.0" renderif={!!props.idp_response}>
   The pending identity provider link Id. This value is created when logging in with an identity provider configured with a linking strategy of <code>Create a pending link</code>. It will only be included in the response body when this strategy is configured and a link does not yet exist for the user. It is used in conjunction with the <a href="/docs/apis/identity-providers/links">Link APIs</a> to complete a pending link.
@@ -12,7 +13,7 @@ import InlineField from 'src/components/InlineField.astro';
 
   You must explicitly allow generation of refresh tokens when using the Login API.
 
-  Configure the <InlineField>application.loginConfiguration.generateRefreshTokens</InlineField> setting via the API or enable the setting by navigating to the <strong>Application -&gt; My Application -&gt; Security</strong> tab.
+  Configure the <InlineField>application.loginConfiguration.generateRefreshTokens</InlineField> setting via the API or enable the setting by navigating to the <Breadcrumb>Application -> My Application -> Security</Breadcrumb> tab.
 </APIField>
 
 <APIField name="refreshTokenId" type="String" since="1.37.0">

@@ -7,6 +7,7 @@ import ScrollRef from 'src/components/ScrollRef.astro';
 import InlineField from 'src/components/InlineField.astro';
 import Aside from 'src/components/Aside.astro';
 import SwaggerExplorer from './_swagger-explorer.astro';
+import Breadcrumb from 'src/components/Breadcrumb.astro';
 
 ## Overview
 
@@ -37,7 +38,7 @@ If you want to use the in-browser API explorer, you have to configure CORS on th
 To set up CORS:
 
 * Log in to your FusionAuth administrative user interface
-* Navigate to <strong>Settings ->System</strong>
+* Navigate to <Breadcrumb>Settings ->System</Breadcrumb>
 * Enable <InlineField>CORS</InlineField>.
 * Update <InlineField>Allowed headers</InlineField> to include `authorization`, `accept` and `content-type` headers.
 * Check all the <InlineField>Allowed methods</InlineField>

@@ -160,7 +160,7 @@ Some APIs may be authenticated by the source IP address of the request. For exam
 
 ## Managing API Keys
 
-Navigate to <strong>Settings -> API Keys</strong> to manage API keys.
+Navigate to <Breadcrumb>Settings -> API Keys</Breadcrumb> to manage API keys.
 
 Create as many API keys as you like, each one may be optionally limited in ability to minimize security risk.
 

@@ -22,6 +22,7 @@ import XForwardedForHeader from 'src/content/docs/apis/identity-providers/_x-for
 import XFusionauthTenantIdHeaderScopedOperationRowOnly from 'src/content/docs/apis/_x-fusionauth-tenant-id-header-scoped-operation-row-only.mdx';
 import IdentityProviderLoginRequestBody from 'src/content/docs/apis/identity-providers/_identity-provider-login-request-body.astro';
 import IdentityProviderLoginResponseBody from 'src/content/docs/apis/identity-providers/_identity-provider-login-response-body.mdx';
+import Breadcrumb from 'src/components/Breadcrumb.astro';
 
 export const idp_since = 12600;
 export const idp_display_name = 'SAML v2 IdP Initiated';
@@ -42,7 +43,7 @@ The SAML v2 IdP Initiated IdP initiated Identity Provider allows an external IdP
 
 The following values will likely be required by your SAML v2 IdP Initiated Identity Provider in order to trust FusionAuth as a relying party.
 
-These values are autogenerated and viewable within the UI after creating the Identity Provider. They can be viewed by navigating to <strong>Settings -> Identity Providers -> SAMLv2 IdP Initiated -> View</strong>.
+These values are autogenerated and viewable within the UI after creating the Identity Provider. They can be viewed by navigating to <Breadcrumb>Settings -> Identity Providers -> SAMLv2 IdP Initiated -> View</Breadcrumb>.
 
 `<base_url>` is the URL for your FusionAuth instance, something like `https://login.piedpiper.com`.
 

@@ -24,6 +24,7 @@ import XForwardedForHeader from 'src/content/docs/apis/identity-providers/_x-for
 import XFusionauthTenantIdHeaderScopedOperationRowOnly from 'src/content/docs/apis/_x-fusionauth-tenant-id-header-scoped-operation-row-only.mdx';
 import IdentityProviderLoginRequestBody from 'src/content/docs/apis/identity-providers/_identity-provider-login-request-body.astro';
 import IdentityProviderLoginResponseBody from 'src/content/docs/apis/identity-providers/_identity-provider-login-response-body.mdx';
+import Breadcrumb from 'src/components/Breadcrumb.astro';
 
 export const idp_since = 10600;
 export const idp_display_name = 'SAML v2';
@@ -46,7 +47,7 @@ FusionAuth will locate the user's email address in the SAML assertion which will
 
 The following values will likely be required by your SAML v2 Identity Provider in order to trust FusionAuth as a relying party.
 
-These values are autogenerated and viewable within the UI after creating the Identity Provider. They can be viewed by navigating to <strong>Settings -> Identity Providers -> SAMLv2 -> View</strong>.
+These values are autogenerated and viewable within the UI after creating the Identity Provider. They can be viewed by navigating to <Breadcrumb>Settings -> Identity Providers -> SAMLv2 -> View</Breadcrumb>.
 
 <SamlConfigUrls />
 

@@ -8,6 +8,7 @@ import JSON from 'src/components/JSON.astro';
 import TroubleshootingApiCalls from 'src/content/docs/_shared/_troubleshooting-api-calls.mdx';
 import NewApiKey401 from 'src/content/docs/apis/_new-api-key-401.mdx';
 import { YouTube } from '@astro-community/astro-embed-youtube';
+import Breadcrumb from 'src/components/Breadcrumb.astro';
 
 ## Overview
 
@@ -91,7 +92,7 @@ _Response Codes_
 | 500  | There was an internal error. A stack trace is provided and logged in the FusionAuth log files. The response will be empty. This is generally a FusionAuth error condition. If possible open a [GitHub Issue](https://github.com/FusionAuth/fusionauth-issues/issues) so we can help you resolve the issue.      |
 | 501  | The HTTP method you requested is not implemented. This is a user error in making the HTTP request to the API.                                                                                                                                                                                                   |
 | 503  | The requested action cannot be completed due the current rate of requests. Retry the request later.                                                                                                                                                                                                             |
-| 512  | A lambda invocation failed during this API request. An event log will have been created with details of the exception. See <strong>System -> Event Log</strong>.                                                                                                                                                |
+| 512  | A lambda invocation failed during this API request. An event log will have been created with details of the exception. See <Breadcrumb>System -> Event Log</Breadcrumb>.                                                                                                                                                |
 
 ## The PATCH HTTP Method
 

@@ -400,7 +400,7 @@ This API allows you to search and paginate through the Login Records. Login Reco
 
 <LoginEvents />
 
-You can limit the number of Login Records retained by navigating to <strong>Settings -> System -> Advanced -> Login record settings</strong> and configuring automatic deletion of Login Records after a certain number of days.
+You can limit the number of Login Records retained by navigating to <Breadcrumb>Settings -> System -> Advanced -> Login record settings</Breadcrumb> and configuring automatic deletion of Login Records after a certain number of days.
 
 ### Request
 

@@ -33,6 +33,7 @@ import XFusionauthTenantIdHeaderAmbiguousOperation from 'src/content/docs/apis/_
 import XFusionauthTenantIdHeaderCreateOperation from 'src/content/docs/apis/_x-fusionauth-tenant-id-header-create-operation.mdx';
 import XFusionauthTenantIdHeaderScopedOperation from 'src/content/docs/apis/_x-fusionauth-tenant-id-header-scoped-operation.mdx';
 import ChangePassResponseCodes from './_change-pass-response-codes.astro';
+import Breadcrumb from 'src/components/Breadcrumb.astro';
 
 ## Overview
 
@@ -822,7 +823,7 @@ If FusionAuth sends an email to the user, it will either use the `email` top lev
 |200 |The request was successful. A JSON response body will be provided when authenticated using an API key, when the API key has been omitted from the request, no response body is provided. |
 |400 |The request was invalid and/or malformed. The response will contain an [Errors](/docs/apis/errors) JSON Object with the specific errors. |
 |401 |You did not supply a valid Authorization header. The header was omitted or your API key was not valid. The response will be empty. See [Authentication](/docs/apis/authentication). |
-|403 |The forgot password functionality has been disabled. This is caused by an administrator setting the Forgot Password Email Template to the option _Feature Disabled. No template selected._ in the Tenant Email configuration. See <strong>Tenants -> Email -> Template settings</strong> in the FusionAuth admin UI. |
+|403 |The forgot password functionality has been disabled. This is caused by an administrator setting the Forgot Password Email Template to the option _Feature Disabled. No template selected._ in the Tenant Email configuration. See <Breadcrumb>Tenants -> Email -> Template settings</Breadcrumb> in the FusionAuth admin UI. |
 |404 |The User could not be found. |
 |422 |The User does not have an email address, this request cannot be completed. Before attempting the request again add an email address to the user. |
 |500 |There was an internal error. A stack trace is provided and logged in the FusionAuth log files. |

@@ -5,6 +5,7 @@ navcategory: installation
 section: archive
 ---
 import Aside from 'src/components/Aside.astro';
+import Breadcrumb from 'src/components/Breadcrumb.astro';
 
 ## Overview
 
@@ -334,5 +335,5 @@ The following is a summary of the steps required to migration to FusionAuth and
  - Upgrade the db schema
  - Create search index
 8. Once logged into FusionAuth rebuild the Elasticsearch index
- - Navigate to <strong>System -> Reindex</strong>.
+ - Navigate to <Breadcrumb>System -> Reindex</Breadcrumb>.
 9. Review your configuration in FusionAuth for accuracy.
@@ -1,5 +1,6 @@
 import InlineField from 'src/components/InlineField.astro';
 import Aside from 'src/components/Aside.astro';
+import Breadcrumb from 'src/components/Breadcrumb.astro';
 
 FusionAuth sends a lot of email, for forgotten passwords, passwordless login and other features.
 
@@ -11,7 +12,7 @@ Troubleshooting email delivery is difficult. There are many factors affecting it
 The *Send Test Email* button has been available since 1.16.0
 </Aside>
 
-The first step is to ensure that you can send a test email. Navigate to <strong>Tenants -> Your Tenant -> Edit -> Email</strong> and send a test email. If it is received, FusionAuth can send emails via SMTP. 
+The first step is to ensure that you can send a test email. Navigate to <Breadcrumb>Tenants -> Your Tenant -> Edit -> Email</Breadcrumb> and send a test email. If it is received, FusionAuth can send emails via SMTP.
 
 <img src="/img/docs/customize/email-and-messages/send-test-email.png" alt="Sending a test email" width="1200" />
 
@@ -39,18 +40,18 @@ html : freemarker.core.InvalidReferenceException: The following has evaluated to
 
 To enable SMTP logging prior to `1.37.0` follow these steps:
 
-1. Enable debugging by navigating to <strong>Tenants -> Your Tenant -> Edit -> Advanced -> SMTP Settings -> Additional properties</strong> and add `mail.debug=true`.
+1. Enable debugging by navigating to <Breadcrumb>Tenants -> Your Tenant -> Edit -> Advanced -> SMTP Settings -> Additional properties</Breadcrumb> and add `mail.debug=true`.
 1. Save the tenant.
 1. Send an email. 
-1. View the system logs by navigating to <strong>System -> Logs</strong>. 
+1. View the system logs by navigating to <Breadcrumb>System -> Logs</Breadcrumb>.
 1. Select `fusionauth-app.log` and you will see verbose SMTP output.
 
 To enable SMTP logging for version `1.37.0` or later follow these steps:
 
-1. Enable debugging by navigating to <strong>Tenants -> Your Tenant -> Edit -> Email -> Debug</strong>.
+1. Enable debugging by navigating to <Breadcrumb>Tenants -> Your Tenant -> Edit -> Email -> Debug</Breadcrumb>.
 1. Save the tenant.
 1. Send an email.
-1. View the Event Logs by navigating to <strong>System -> Event Logs</strong>.
+1. View the Event Logs by navigating to <Breadcrumb>System -> Event Logs</Breadcrumb>.
 1. Select the Event Log that starts with `"Email debug information"`.
 
 Doing this logs the full SMTP conversation, which can be verbose. You should remove this setting when you have finished troubleshooting.