• Enums
  • Enumeration: AuthRetCode
    • Table of contents
    • Enumeration Members
• Interfaces
  • Interface: AuthResult
    • Table of contents
    • Properties
  • Interface: UserInfo
    • Table of contents
    • Properties
• hxssoapi
  • Table of contents
    • Enumerations
    • Interfaces
    • Functions
  • Functions
    • tokenAuth

Enums

Enumeration: AuthRetCode

认证结果返回码

Table of contents

Enumeration Members

• InvaildToken
• NetworkFault
• OK
• ServerFault

Enumeration Members

InvaildToken

• InvaildToken = 3

令牌错误

NetworkFault

• NetworkFault = 1

网络连接故障

OK

• OK = 0

成功

ServerFault

• ServerFault = 2

服务器错误

Interfaces

Interface: AuthResult

认证结果

Table of contents

Properties

• resultComment
• retCode
• userInfo

Properties

resultComment

• Optional resultComment: string

错误说明

retCode

• retCode: AuthRetCode

返回结果码

userInfo

• Optional userInfo: UserInfo

认证成功返回的对应用户账号信息

Interface: UserInfo

认证成功返回用户信息

Table of contents

Properties

• userID
• userName
• userRole

Properties

userID

• userID: string

用户账号

userName

• userName: string

用户名称

userRole

• userRole: string

用户角色(身份)名

hxssoapi

Table of contents

Enumerations

• AuthRetCode

Interfaces

• AuthResult
• UserInfo

Functions

• tokenAuth

Functions

tokenAuth

▸ tokenAuth(serverURL, token, backServerURL?): Promise<UserInfo>

请求调度服务器单点会话认证

Parameters

| Name | Type | Description | | :------ | :------ | :------ | | serverURL | string | 认证服务器URL | | token | string | 认证令牌 | | backServerURL? | string | 可选的备用认证服务器URL |

Returns

Promise<UserInfo>

用户账号信息UserInfo