logologo
Get Started
Guide
Development
Plugins
API
English
简体中文
Get Started
Guide
Development
Plugins
API
English
简体中文
logologo

Authentication

Overview
Authenticators

Authentication type

Password
SMS

OIDC

Configuration

Examples

Google
Microsoft Entra ID

SAML

Configuration

Examples

Google Workspace
LDAP
CAS
API keys

Development

Extentd authentication type
API

Verification

Overview

Verification type

SMS
TOTP authenticator

Development

Extend verification type
Extend verification scene
Extend SMS provider
API
Two factor authentication (2FA)
Next PageAuthenticators

#User Authentication

The user authentication module of NocoBase mainly consists of two parts:

  • The @nocobase/auth in the kernel defines login, registration, verification and other user authentication related expandable interfaces and middleware, and is also used for registering and managing various extended authentication methods.
  • The @nocobase/plugin-auth in the plugin is used to initialize the authentication management module in the kernel, and also provides basic username (or email) / password authentication method.

It needs to be used in conjunction with the user management function provided by the @nocobase/plugin-users plugin.

In addition, NocoBase also provides other various user authentication method plugins:

  • @nocobase/plugin-auth-sms - Provides SMS verification login function
  • @nocobase/plugin-auth-saml - Provides SAML SSO login function
  • @nocobase/plugin-auth-oidc - Provides OIDC SSO login function
  • @nocobase/plugin-auth-cas - Provides CAS SSO login function
  • @nocobase/plugin-auth-ldap - Provides LDAP SSO login function
  • @nocobase/plugin-auth-wecom - Provides WeCom login function
  • @nocobase/plugin-auth-dingtalk - Provides DingTalk login function

Through the above plugins, after the administrator configures the corresponding authentication method, users can directly use the user identity provided by platforms such as Google Workspace, Microsoft Azure to log in to the system, and can also connect to Auth0, Logto, Keycloak and other platform tools. In addition, developers can also conveniently expand other authentication methods they need through the basic interfaces we provide.