logologo
Get Started
Guide
Development
Plugins
API
Home
English
简体中文
日本語
한국어
Español
Português
Deutsch
Français
Русский
Italiano
Türkçe
Українська
Tiếng Việt
Bahasa Indonesia
ไทย
Polski
Nederlands
Čeština
العربية
עברית
हिन्दी
Svenska
Get Started
Guide
Development
Plugins
API
Home
logologo
API Overview

@nocobase/auth

AuthManager
Auth
BaseAuth

@nocobase/cli

NocoBase CLI
Global Environment Variables

@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/flow-engine

DataSourceManager
FlowContext
FlowEngine
FlowModel
FlowResource

@nocobase/server

AppCommand
Application
AuditManager
Context
Migration
Plugin

@nocobase/sdk

Auth
Storage

@nocobase/telemetry

Metric
Telemetry
Trace
Previous Page@nocobase/sdk
Next PageStorage

#Auth

#Overview

The Auth class is mainly used on the client side to access user information and request user authentication-related APIs.

#Instance Properties

#locale

The language used by the current user.

#role

The role used by the current user.

#token

API token.

#authenticator

The authenticator used for the current user's authentication. See User Authentication.

#Class Methods

#signIn()

User sign in.

#Signature

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

#Details

Parameter NameTypeDescription
valuesanyRequest parameters for the sign-in API
authenticatorstringThe identifier of the authenticator used for sign-in

#signUp()

User sign up.

#Signature

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

#Details

Parameter NameTypeDescription
valuesanyRequest parameters for the sign-up API
authenticatorstringThe identifier of the authenticator used for sign-up

#signOut()

Sign out.

#Signature

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

#Details

Parameter NameTypeDescription
valuesanyRequest parameters for the sign-out API
authenticatorstringThe identifier of the authenticator used for sign-out