Skip to main content

Overview

Casdoor utilizes providers to offer third-party services for the platform. In this chapter, you will learn how to add providers to Casdoor.

What We Have​

Currently, we have six types of providers:

  • OAuth Providers

    Casdoor allows users to sign in through other OAuth applications. You can add GitHub, Google, QQ, and many other OAuth applications to Casdoor. For more details, please refer to the OAuth section.

  • SMS Providers

    Casdoor sends SMS to users when they want to verify their phone numbers. SMS providers are used to send SMS in Casdoor.

  • Email Providers

    Email providers are similar to SMS providers.

  • Storage Providers

    Casdoor allows users to store files using the local file system or cloud OSS services.

  • Payment Providers

    Casdoor can add payment providers, which will be used to add payment methods to products on the product page. Currently, the supported payment providers include Alipay, WeChat Pay, PayPal, and GC.

  • Captcha Providers

    Casdoor supports configurable captcha in user flows. Currently, the supported captcha providers include Default Captcha, reCAPTCHA, hCaptcha, Alibaba Cloud Captcha, and Cloudflare Turnstile.

How to Configure and Use​

Scope​

Providers have different scopes, which are determined by the creator. Only Administrators have the permission to add and configure providers. There are two types of Administrators in Casdoor:

  • Global Administrator: All users under the built-in organization and the users who enable IsGlobalAdmin. The providers created by the Global Administrator can be used by all applications.

  • Organization Administrator: Users who enable IsAdmin. The providers created by the Organization Administrator can only be used by the applications under the organization (under development...).

Add to Application​

Follow the steps below to add providers to your application. Note that you cannot use the provider in your application until you have added it.

  1. Go to the application edit page and add a new provider row.

    provider_overview_add

  2. Select a provider that you want to add to the application. You will see all the providers that the application can use.

    provider_overview_select

  3. For OAuth and Captcha providers, you can configure their usage. See OAuth and Captcha for more information.

    provider_overview_config

Finally, save the configuration. You can now try using the provider in your application.