Circle supports Single Sign-On (SSO) via OAuth 2.0.

The benefit of having SSO enabled for your community is that you can integrate user login accounts from your own platform, creating a seamless experience! Your users won't have to sign up or log in with their Circle account — instead, they'll use your own authentication provider and access Circle from your log in page.

This guide is for Custom SSO, if you are looking for a specific guide, please use the suggested links at the bottom of this article. To see what SSO providers are covered under your plan, click here.

🚨 If you plan to use a custom domain, set that up first as this will change your Callback URL. Not doing this first can potentially lead to being locked out of your account.

Once SSO is enabled for your community, you will be able to navigate to Community Settings → Single Sign-On and input credentials.

🚨 We recommend keeping the "Allow members with a Circle account to sign in" toggle enabled to avoid getting locked out of your account while setting up your SSO integration. In the case this happens, you can easily sign in again with your Circle credentials.

Step 1: Provide the name of your OAuth provider
Use the dropdown to select your OAuth provider. The name field is what will display under the login button. For example, if you input the name "Facebook", the login button will say "Continue with Facebook."

Step 2: Insert your custom OAuth provider details
The Client ID, Secret Key, Authorization URL, Token Fetch URL, and User Info API URL should be provided to you by your OAuth provider.

Step 3: Set up the response paths
This is the API URL for Circle to fetch user profile information such as email, name, and profile picture after authentication. Your OAuth provider should be able to provide these.

Response paths refer to nested information in your JSON API response. For example, if a user's email is returned by your API inside a "user" object, the response path should be user/email. In JSON, this will look something like:

{
  user: {
    email: "a-user@email.com",
    ...
  }
}


Once your keys are generated you may need to reference the callback URL which is provided at the top of the page.

Click "Save changes" once the fields are completed.

✅ Step 4: Turn SSO on

Until you turn this toggle on, you will continue to see our standard login screen. Once you turn it on, we will hide all other ways to sign up and log in (email, Facebook, Twitter, etc) and your users will only be able to log in via your SSO OAuth provider.

As an admin, you'll need to ensure that your existing Circle email has a corresponding account in your custom OAuth setup with the same email — we'll automatically match up the two accounts when you log in, and you'll be able to use the account from your OAuth provider going forward.

🏁 If the setup was successful, you and your members will now see a page like this if you're logged out. And when you click on the "Continue with ..." button, you'll be taken to the login page for your custom OAuth provider!


Suggested Articles: