Skip to main content

How to Enable Single Sign-On

Introduction​

You have connected Casdoor and configured more than one application in an organization. You want users to sign in once to any app in nomeguythe organization, and then be able to sign in when they go to another app, without any extra clicks.

We offer this single sign-on, you just need to:

  • Enable Auto signin button.
  • Fill in the URL for home page.
  • Add a Silent Signin function to the application home page.
note

The basic sign in process provided by Casdoor allows users to log in to other applications in the organization by selecting the user who is currently logged in or using another account.

After enable the auto signin, the selection box will not display, the logged user will log in directly.

Configure​

  1. Fill the field home. It can be the application's home page or the login page.

sso_home.png 2. Enable Auto signin button.

sso_signin.png

Add Silent Signin​

In fact, we implement auto login by carrying parameters on the URL. So your applications need to have a method to trigger the login after jumping to the URL. We provide casdoor-react-sdk for you to quickly implement the feature. You can see details in use-in-react.

info

How it works

  1. In the URL to the application home page, we will carry the silentSignin parameter.
  2. In your HomePage to determine whether you need to log in silently(automatically) by the parameter silentSignin. If silentSignin === 1, the function returns the SilentSignin component, it will help you initiate a login request. And since you have auto-login enabled, users will log in automatically without clicking.

Add Popup Signin​

popup signin will pop up a small window. After logging in to Casdoor in the child window, it will send authentication information to the main window and then close automatically. We implement it by carrying parameters on the URL.

info

How to use

Use the method popupSignin() in sdk casdoor-js-sdk to quickly implement the feature. You can see a demo in casdoor-nodejs-react-example.

How it works

  1. In the URL to the application home page, we will carry the popup parameter.
  2. When popup=1 in login params, Casdoor will send code and state as a message to main window and finish get token in main window by SDK.

Using SSO​

The configuration is complete, below will show you how to use auto login.

info

Make sure in your application can redirect to user's profile page. The API getMyProfileUrl(account, returnUrl) is provided in our SDK for each language.

Open the profile page and go to the "Home" page (/ URL path). You will see the application list provided by the organization. It's notable that only users in organizations other that built-in can see the application list in the "Home" page. All the global administrators (aka in the built-in organization) cannot see it.

sso_homepage.png

Click on a tile in the application list, it will jump to the homepage URL of that application with GET parameter: ?silentSignin=1 and automatically log into the application if the application has integrated with Casdoor SSO (so it will recognize the ?silentSignin=1 parameter and perform silent login in the background).