docs: add instructions for enabling SSO for existing users (#4014)

* docs: add instructions for enabling SSO for existing users

* fix: update sentence to emphasize admin

Reword sentence for clarity that admins are the ones supposed to carry out the enable SSO action for existing users

* fix: remove extraneous whitespace
This commit is contained in:
Kelvin Oghenerhoro Omereshone 2022-02-08 05:56:02 +01:00 committed by GitHub
parent 4ecb61e61c
commit c507aff94b
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -687,7 +687,7 @@ Configures the TLS settings for compatibility with various user agents. Options
Sets a URL prefix to use when serving the Fleet API and frontend. Prefixes should be in the form `/apps/fleet` (no trailing slash).
Note that some other configurations may need to be changed when modifying the URL prefix. In particular, URLs that are provided to osquery via flagfile, the configuration served by Fleet, the URL prefix used by `fleetctl`, and the redirect URL set with an SSO Identity Provider.
Note that some other configurations may need to be changed when modifying the URL prefix. In particular, URLs that are provided to osquery via flagfile, the configuration served by Fleet, the URL prefix used by `fleetctl`, and the redirect URL set with an Identity Provider.
- Default value: Empty (no prefix set)
- Environment variable: `FLEET_SERVER_URL_PREFIX`
@ -2045,6 +2045,9 @@ It is strongly recommended that at least one admin user is set up to use the tra
based log in so that there is a fallback method for logging into Fleet in the event of SSO
configuration problems.
### Enabling SSO for existing users in Fleet
As an admin, you can enable SSO for existing users in Fleet. To do this, go to the Settings page, then click on the Users tab. Locate the user you want to enable SSO for and on the actions dropdown menu for that user, click on "Enable single sign on".
#### Okta IDP Configuration
![Example Okta IDP Configuration](https://raw.githubusercontent.com/fleetdm/fleet/main/docs/images/okta-idp-setup.png)