diff --git a/docs/Configuration/yaml-files.md b/docs/Configuration/yaml-files.md index bca5256da8b..4f07d0fec80 100644 --- a/docs/Configuration/yaml-files.md +++ b/docs/Configuration/yaml-files.md @@ -866,9 +866,10 @@ org_settings: ### fleet_desktop -The `fleet_desktop` section lets you customize the Fleet Desktop experience by overriding default URLs. +The `fleet_desktop` section lets you customize the Fleet Desktop experience. - `transparency_url` directs end users to a custom URL when they select **About Fleet** in the Fleet Desktop dropdown (default: [https://fleetdm.com/transparency](https://fleetdm.com/transparency)). - `alternative_browser_host` is a custom hostname that my hosts will access Fleet Desktop from. +- `sso_enabled` determines whether to require IdP authentication in addition to the Fleet Desktop token to access the device page. Can only be configured for "All fleets" (`org_settings`). @@ -879,6 +880,7 @@ org_settings: fleet_desktop: transparency_url: https://example.org/transparency alternative_browser_host: fleet-desktop.example.com + sso_enabled: false ``` ### gitops diff --git a/docs/REST API/rest-api.md b/docs/REST API/rest-api.md index 8f52505c500..8f5986daa74 100644 --- a/docs/REST API/rest-api.md +++ b/docs/REST API/rest-api.md @@ -2309,7 +2309,8 @@ Modifies the Fleet's configuration with the supplied information. }, "fleet_desktop": { "transparency_url": "https://fleetdm.com/better", - "alternative_browser_host": "fleet-desktop.example.com" + "alternative_browser_host": "fleet-desktop.example.com", + "sso_enabled": false }, "gitops": { "gitops_mode_enabled": false, @@ -2573,6 +2574,7 @@ _Available in Fleet Premium._ | --------------------- | ------- | -------------------------------------------------------------------------------- | | transparency_url | string | The URL used to display transparency information to users of Fleet Desktop. | | alternative_browser_host | string | The hostname used to navigate Fleet Desktop traffic through. | +| sso_enabled | boolean | Whether end users must sign in via SSO before accessing Fleet Desktop. Requires an IdP configured. |
@@ -2582,7 +2584,8 @@ _Available in Fleet Premium._ { "fleet_desktop": { "transparency_url": "https://fleetdm.com/better", - "alternative_browser_host": "fleet-desktop.example.com" + "alternative_browser_host": "fleet-desktop.example.com", + "sso_enabled": false } } ```