Update YAML docs to support idp_image_url (#26104)

Supported with `fleetctl gitops` but not included in the YAML docs at https://fleetdm.com/docs/configuration/yaml-files#sso-settings. --------- Co-authored-by: Rachael Shaw <[email protected]>
fleetdm · Feb 13, 2025 · 1a7f421 · 1a7f421
1 parent 92fc34b
commit 1a7f421
Showing 1 changed file with 2 additions and 0 deletions.
diff --git a/docs/Configuration/yaml-files.md b/docs/Configuration/yaml-files.md
@@ -498,6 +498,7 @@ The `sso_settings` section lets you define single sign-on (SSO) settings. Learn
 
 - `enable_sso` (default: `false`)
 - `idp_name` is the human-friendly name for the identity provider that will provide single sign-on authentication (default: `""`).
+- `idp_image_url` is an optional link to an image such as a logo for the identity provider. (default: `""`).
 - `entity_id` is the entity ID: a Uniform Resource Identifier (URI) that you use to identify Fleet when configuring the identity provider. It must exactly match the Entity ID field used in identity provider configuration (default: `""`).
 - `metadata` is the metadata (in XML format) provided by the identity provider. (default: `""`)
 - `metadata_url` is the URL that references the identity provider metadata. Only one of  `metadata` or `metadata_url` is required (default: `""`).
@@ -513,6 +514,7 @@ org_settings:
   sso_settings:
     enable_sso: true
     idp_name: Okta
+    idp_image_url: https://www.okta.com/favicon.ico
     entity_id: https://example.okta.com
     metadata: $SSO_METADATA
     enable_jit_provisioning: true # Available in Fleet Premium