管理主体认证

更新时间: 2022-03-01 17:48:57

此模块用于为用户进行主体认证，如个人认证或企业认证。

示例代码：

import { ManagementClient } from 'authing-js-sdk'
const managementClient = new AuthenticationClient({
  userPoolId: 'YOUR_USERPOOL_ID',
  secret: 'YOUR_USERPOOL_SECRET',
})

authenticationClient.principal.detail
authenticationClient.principal.authenticate

获取认证详情

获取主体认证详情

PrincipalManagementClient().detail(userId)

参数

• userId <string>，用户 ID

示例

const managementClient = new ManagementClient({
  userPoolId: 'YOUR_USERPOOL_ID',
  secret: 'YOUR_USERPOOL_SECRET',
})

const principalInfo = await managementClient.principal.detail('xxxxxxxxxxxxx')

返回值

• Promise<PrincipalDetail | null>，未认证时返回 null

示例数据

{
  "id": "60b4d72f56b49fb97281001b",
  "createdAt": "2021-05-31T12:31:43.416Z",
  "updatedAt": "2021-05-31T12:31:43.416Z",
  "userPoolId": "607fe30c14d1650eb1d888ca",
  "userId": "60a336dc179abb512dd64ae7",
  "principalType": "P", // "P" 表示个人认证，"E" 表示个人认证
  "principalName": "xxx",
  "principalCode": "xxxxxxxxxxxxxxx",
  "authenticationTime": "2021-05-31T12:31:43.414Z"
}

进行主体认证

进行主体认证

PrincipalAuthentication().authenticate(userId, principalInfo)

参数

在进行个人认证和企业认证时传入的参数会有区别，具体如下。

个人认证

• userId: <string>，用户 ID
• principalInfo: <object>
  • principalInfo.type: <string>，个人认证时应该传入固定字符串 "P"
  • principalInfo.name: <string>，个人真实名字
  • principalInfo.idCard: <string>，个人身份证号
  • principalInfo.bankCard: <string>，个人银行卡号

企业认证

• principalInfo: <object>
  • principalInfo.type: <string>，企业认证时应该传入固定字符串 "E"
  • principalInfo.enterpriseName: <string>，企业名称
  • principalInfo.enterpriseCode: <string>，企业统一社会信用代码
  • principalInfo.legalPersonName: <string>，企业法人名字

示例

const managementClient = new ManagementClient({
  userPoolId: 'YOUR_USERPOOL_ID',
  secret: 'YOUR_USERPOOL_SECRET',
})

await managementClient.principal.authenticate({
  type: 'P',
  name: 'xxx',
  idCard: 'xxxxxxxxxxxxxxxx',
  bankCard: 'xxxxxxxxxxxxxxxxxxxxxxxxxxx',
})

返回值

• Promise<boolean>，认证成功返回 true

示例数据

true