Skip to content

Update rest-api.md #51155

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

Open
rachaelshaw wants to merge 2 commits into
base: docs-v4.92.0
Choose a base branch
from
+8 −3
Open

Update rest-api.md #51155

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
94ca59f
Update rest-api.md
rachaelshaw Aug 12, 2026
4e5270a
Update yaml-files.md
rachaelshaw Aug 13, 2026
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: 3 additions & 1 deletion docs/Configuration/yaml-files.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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`).

Expand All @@ -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
Expand Down
7 changes: 5 additions & 2 deletions docs/REST API/rest-api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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,
Expand Down Expand Up @@ -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. |

<br/>

Expand All @@ -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
}
}
```
Expand Down
Loading