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)
Previous PageCAS
Next PageExtentd authentication type

#API Keys

#Introduction

#Usage Instructions

http://localhost:13000/admin/settings/api-keys/configuration

#Add API Key

Notes

  • The API key is created for the current user and inherits the user's role.
  • Please make sure that the APP_KEY environment variable has been configured and is kept confidential. If the APP_KEY changes, all added API keys will become invalid.

#How to configure APP_KEY

For the docker version, modify the docker-compose.yml file

services:
  app:
    image: nocobase/nocobase:main
    environment:
+     - APP_KEY=4jAokvLKTJgM0v_JseUkJ

For the source code or create-nocobase-app installation, you can directly modify the APP_KEY in the .env file

APP_KEY=4jAokvLKTJgM0v_JseUkJ