logologo
Начало
Руководство
Разработка
Плагины
API
English
简体中文
日本語
한국어
Deutsch
Français
Español
Português
Русский
Italiano
Türkçe
Українська
Tiếng Việt
Bahasa Indonesia
ไทย
Polski
Nederlands
Čeština
العربية
עברית
हिन्दी
Svenska
Начало
Руководство
Разработка
Плагины
API
logologo
Обзор API

@nocobase/auth

AuthManager
Auth
BaseAuth

@nocobase/cache

CacheManager
Кэш

@nocobase/cli

NocoBase CLI
Глобальные переменные окружения

@nocobase/client

Приложение
Плагин

@nocobase/database

Коллекция
Поле

interfaces

BaseInterface
Операторы фильтрации

RelationRepository

BelongsToManyRepository
belongs-to-repository
HasManyRepository
HasOneRepository
Репозиторий

shared

create-options
destroy-options
find-one
find-options
transaction
update-options

@nocobase/data-source-manager

DataSourceManager
DataSource (абстрактный)
ICollectionManager
ICollection
IField
IModel
IRepository

@nocobase/flow-engine

Менеджер источников данных
Контекст потока
FlowEngine
Модель потока
Ресурс рабочего процесса

@nocobase/logger

Логгер

@nocobase/server

AppCommand
Приложение
AuditManager
Контекст
Миграция
Плагин

@nocobase/sdk

Auth
Storage
Previous PageAuth
Next PageCacheManager
Уведомление о переводе ИИ

Эта документация была автоматически переведена ИИ.

#BaseAuth

#Обзор

BaseAuth наследует от абстрактного класса Auth и представляет собой базовую реализацию для типов аутентификации пользователей, использующую JWT в качестве метода аутентификации. В большинстве случаев при расширении типов аутентификации пользователей вы можете наследовать от BaseAuth, и нет необходимости напрямую наследовать от абстрактного класса Auth.

class BasicAuth extends BaseAuth {
  constructor(config: AuthConfig) {
    // Устанавливаем коллекцию пользователей
    const userCollection = config.ctx.db.getCollection('users');
    super({ ...config, userCollection });
  }

  // Логика аутентификации пользователя, вызывается методом `auth.signIn`
  // Возвращает данные пользователя
  async validate() {
    const ctx = this.ctx;
    const { values } = ctx.action.params;
    // ...
    return user;
  }
}

#Методы класса

#constructor()

Конструктор, создает экземпляр BaseAuth.

#Сигнатура

  • constructor(config: AuthConfig & { userCollection: Collection })

#Подробности

ПараметрТипОписание
configAuthConfigСм. Auth - AuthConfig
userCollectionCollectionКоллекция пользователей, например: db.getCollection('users'). См. DataBase - Collection

#user()

Аксессор, который устанавливает и получает информацию о пользователе. По умолчанию использует объект ctx.state.currentUser для доступа.

#Сигнатура

  • set user()
  • get user()

#check()

Выполняет аутентификацию по токену запроса и возвращает информацию о пользователе.

#signIn()

Вход пользователя, генерирует токен.

#signUp()

Регистрация пользователя.

#signOut()

Выход пользователя, аннулирует токен.

#validate() *

Основная логика аутентификации, вызывается методом signIn для определения возможности успешного входа пользователя в систему.