logologo
开始
手册
开发
插件
API
English
简体中文
开始
手册
开发
插件
API
English
简体中文
logologo
API Overview

@nocobase/auth

AuthManager
Auth
BaseAuth

@nocobase/cache

CacheManager
Cache

@nocobase/cli

NocoBase CLI
全局环境变量

@nocobase/client

Application
Plugin

@nocobase/database

Collection
Field

interfaces

BaseInterface
Filter Operators

RelationRepository

BelongsToManyRepository
belongs-to-repository
HasManyRepository
HasOneRepository
Repository

shared

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

@nocobase/data-source-manager

DataSourceManager
DataSource (abstract)
ICollectionManager
ICollection
IField
IModel
IRepository

@nocobase/flow-engine

DataSourceManager
FlowContext
FlowEngine
FlowModel
FlowResource

@nocobase/logger

Logger

@nocobase/server

AppCommand
Application
AuditManager
Context
Migration
Plugin

@nocobase/sdk

Auth
Storage
Previous Page@nocobase/sdk
Next PageStorage

#Auth

#概览

Auth 类主要用于在客户端存取用户信息,请求用户认证相关接口。

#实例属性

#locale

当前用户使用的语言。

#role

当前用户使用的角色。

#token

API 接口 token.

#authenticator

当前用户认证时所用的认证器。参考 用户认证。

#类方法

#signIn()

用户登录。

#签名

  • async signIn(values: any, authenticator?: string): Promise<AxiosResponse<any>>

#详细信息

参数名类型描述
valuesany登录接口请求参数
authenticatorstring登录使用的认证器标识

#signUp()

用户注册。

#签名

  • async signUp(values: any, authenticator?: string): Promise<AxiosResponse<any>>

#详细信息

参数名类型描述
valuesany注册接口请求参数
authenticatorstring注册使用的认证器标识

#signOut()

注销登录。

#签名

  • async signOut(values: any, authenticator?: string): Promise<AxiosResponse<any>>

#详细信息

参数名类型描述
valuesany注销接口请求参数
authenticatorstring注销使用的认证器标识