Clarify what the Entity ID is (#44012)

The most common misunderstanding that our users have when configuring
SSO (specifically Okta, since it refers to the value by a different
name) is what to put in this Entity ID field. If it doesn't match the
IdP's version, SSO will fail.

We were also directing users to retrieve an issuer URI, which would
presumably be used as the Entity ID. The problem is, the rest of our
docs don't state that, and instead tell users to use a simple value such
as `fleet`.
This commit is contained in:
Steven Palmesano
2026-05-04 16:18:00 -05:00
committed by GitHub
parent 92c672d77f
commit da01caf3c0
4 changed files with 4 additions and 6 deletions
+1 -3
View File
@@ -15,11 +15,9 @@ Create a new SAML app in Okta:
If you're configuring [end user authentication](https://fleetdm.com/guides/setup-experience#end-user-authentication), use `https://<your_fleet_url>/api/v1/fleet/mdm/sso/callback` for the **Single sign on URL** instead.
Once configured, you will need to retrieve the issuer URI from **View Setup Instructions** and metadata URL from the **Identity Provider metadata** link within the application **Sign on** settings. See below for where to find them:
> Note that while setting up the SAML app in Okta, the Entity ID is called "Audience URI (SP Entity ID)", but after the app is set up, Okta labels this as "Audience Restriction".
![Where to find SSO links for Fleet](https://raw.githubusercontent.com/fleetdm/fleet/main/docs/images/okta-retrieve-links.png)
Once configured, you will need to retrieve the Identity Provider metadata URL either from **View Setup Instructions** from the **Identity Provider metadata** link within the application **Sign on** settings, or under the **SAML 2.0** section under **Metadata details**.
> The Provider Sign-on URL within **View Setup Instructions** has a similar format as the Provider SAML Metadata URL, but this link provides a redirect to _sign into_ the application, not the metadata necessary for dynamic configuration.
Binary file not shown.

Before

Width:  |  Height:  |  Size: 74 KiB

@@ -170,7 +170,7 @@ const EndUserAuthSection = ({
value={formData.entity_id}
parseTarget
error={formErrors?.entity_id}
tooltip="The required entity ID is a URI that you use to identify Fleet when configuring the identity provider."
tooltip="The Entity ID is a required URI that you use to identify Fleet when configuring the identity provider. Okta calls this Audience Restriction."
/>
<InputField
label="Metadata URL"
@@ -237,14 +237,14 @@ const Sso = ({
/>
<InputField
label="Entity ID"
helpText="The URI you provide here must exactly match the Entity ID field used in identity provider configuration."
helpText="The URI you provide here must exactly match the Entity ID field used in the identity provider configuration."
onChange={onInputChange}
name="entityId"
value={entityId}
parseTarget
onBlur={onInputBlur}
error={formErrors.entity_id}
tooltip="The required entity ID is a URI that you use to identify Fleet when configuring the identity provider."
tooltip="The Entity ID is a required URI that you use to identify Fleet when configuring the identity provider. Okta calls this Audience Restriction."
/>
<InputField
label="IdP image URL"