Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

updated to reflect that FQDN should include prefix for OIDC compliance. #3486

Merged
merged 4 commits into from
Jan 29, 2025
Merged

updated to reflect that FQDN should include prefix for OIDC compliance. #3486

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
fe66408
updated to reflect that FQDN should include prefix for OIDC compliance.
mooreds Jan 28, 2025
a65e9e0
don't use fusionauth.io as an example domain
mooreds Jan 29, 2025
85698dc
updated 'strong' to breadcrumb because it is navigation
mooreds Jan 29, 2025
0c24c66
satisfy eslint
mooreds Jan 29, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions astro/src/content/docs/apis/_tenant-request-body.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -405,8 +405,8 @@ import TransactionTypes from 'src/content/docs/apis/_transaction-types.mdx';
Time in seconds until an inactive session will be invalidated. Used when creating a new session in the FusionAuth OAuth frontend.
</APIField>

<APIField name="tenant.issuer" type="String" optional since="1.8.0">
The named issuer used to sign tokens, this is generally your public fully qualified domain.
<APIField name="tenant.issuer" type="String" optional since="1.8.0" defaults="acme.com">
The named issuer used to sign tokens. This is generally your public fully qualified domain with the `https://` protocol prefix. For example, `https://example.com`.

Prior to version `1.30.0` this value was required.
</APIField>
Expand Down
2 changes: 1 addition & 1 deletion astro/src/content/docs/apis/_tenant-response-body-base.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -324,7 +324,7 @@ import JSON from 'src/components/JSON.astro';
</APIField>

<APIField name={props.base_field_name + '.issuer'} type="String" since="1.8.0">
The named issuer used to sign tokens, this is generally your public fully qualified domain.
The named issuer used to sign tokens. This is generally your public fully qualified domain with the `https://` protocol prefix. For example, `https://example.com`.
</APIField>

<APIField name={props.base_field_name + '.jwtConfiguration.accessTokenKeyId'} type="UUID" since="1.8.0">
Expand Down
11 changes: 6 additions & 5 deletions astro/src/content/docs/get-started/core-concepts/tenants.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ import APIField from 'src/components/api/APIField.astro';
import AvailableSince from 'src/components/api/AvailableSince.astro';
import DefaultSMTPConfigurationProperties from 'src/content/docs/_shared/default-smtp-configuration-properties.mdx';
import PremiumPlanBlurb from 'src/content/docs/_shared/_premium-plan-blurb.astro';
import Breadcrumb from 'src/components/Breadcrumb.astro';
import InlineField from 'src/components/InlineField.astro';
import InlineUIElement from 'src/components/InlineUIElement.astro';
import ScrollRef from 'src/components/ScrollRef.astro';
Expand Down Expand Up @@ -43,15 +44,15 @@ Here's a brief video covering some aspects of tenants:

Below is a visual reminder of the relationships between FusionAuth's primary core concepts.

<img src="/img/docs/get-started/core-concepts/core-concepts-relationships-tenants.png" alt="Diagram showing Tenants used within FusionAuth" />
![Diagram showing Tenants used within FusionAuth.](/img/docs/get-started/core-concepts/core-concepts-relationships-tenants.png)

## Admin UI

This page describes the admin UI for creating and configuring a Tenant.

### List of Tenants

To display a list of tenants, navigate to <strong>Tenants</strong>.
To display a list of tenants, navigate to <Breadcrumb>Tenants</Breadcrumb>.

<img src="/img/docs/get-started/core-concepts/tenant-configuration-list.png" alt="List of Tenants" width="1200" role="bottom-cropped" />

Expand All @@ -67,9 +68,9 @@ Using the icons on this screen, you can:

### Create a Tenant

To create a new tenant, navigate to <strong>Tenants</strong>.
To create a new tenant, navigate to <Breadcrumb>Tenants</Breadcrumb>.

<img src="/img/docs/get-started/core-concepts/create-tenant.png" alt="Create a Tenant" width="1200" role="shadowed" />
![Create a Tenant.](/img/docs/get-started/core-concepts/create-tenant.png)

### Tenant Configuration
A majority of your FusionAuth configuration is managed at the Tenant-level. Some of these configuration options act as defaults and can be overridden by the Application.
Expand All @@ -81,7 +82,7 @@ A majority of your FusionAuth configuration is managed at the Tenant-level. Som

<APIBlock>
<APIField name="Issuer" required>
The named issuer used to sign tokens. Typically a fully-qualified domain name.
The named issuer used to sign tokens. This is generally your public fully qualified domain with the `https://` protocol prefix. For example, `https://example.com`.
</APIField>
<APIField name="Login Theme" optional>
The Theme associated with this Tenant; determines which templates to render for interactive work-flows.
Expand Down