Skip to content

Commit

Permalink
Add Enabling SSO section & small adjustments
Browse files Browse the repository at this point in the history
  • Loading branch information
Bubka committed Apr 12, 2024
1 parent ba8d4f4 commit 953344c
Showing 1 changed file with 6 additions and 2 deletions.
8 changes: 6 additions & 2 deletions docs/security/Authentication/sso.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,10 @@ SSO is probably overkill for a single user usage but becomes relevant in a multi
For now 2FAuth only supports 2 SSO providers: __OpenID__ and __Github__
!!!

## Enabling SSO

SSO is enabled by default. You can check it at _Admin > App setup_, in the _Registrations_ section.

## Enable a provider

### Create the client
Expand Down Expand Up @@ -93,13 +97,13 @@ When you sign in via SSO for the first time, you are registered to 2FAuth transp

## Disabling SSO

As an administrator, you can fully disable Single sign-On from the 2FAuth UI.
As an administrator, you can fully disable Single Sign-On from the 2FAuth UI.

Go to _Admin > App setup_, scroll down to the _Registrations_ section and uncheck [!badge size="l" icon="checkbox" text="Enable Single Sign-On"].

Note that:

- Existing "SSO users" won't be able to sign in via SSO anymore, but their accounts remain. Still, the password reset feature can be used so they can get a password and sign in again.
- There is no need to disable the providers env vars.
- There is no need to unset the providers env vars.

Enabling back SSO restores the providers and the ability for SSO users to sign in again.

0 comments on commit 953344c

Please sign in to comment.