¶ 判断用户是否存在

更新时间: 2024-10-10 07:28:40

根据条件判断用户是否存在，可以筛选用户名、邮箱、手机号、第三方外部 ID 等。

¶ 请求参数

名称	类型	必填	默认值	描述	示例值
username	string	否	-	用户名，用户池内唯一。	`bob`
email	string	否	-	邮箱。	`test@example.com`
phone	string	否	-	手机号。	`188xxxx8888`
externalId	string	否	-	第三方外部 ID。	`10010`

¶ 示例代码

import { ManagementClient } from 'authing-node-sdk';
// 在 Node.js 中引用：
// const { ManagementClient } = require('authing-node-sdk');

const managementClient = new ManagementClient({
  accessKeyId: 'AUTHING_USERPOOL_ID',
  accessKeySecret: 'AUTHING_USERPOOL_SECRET',
});

(async () => {
  const result = await managementClient.isUserExists({
    username: 'bob',
    email: 'test@example.com',
    phone: '188xxxx8888',
    externalId: '10010',
 });
})();

¶ 请求响应

类型： IsUserExistsRespDto

名称	类型	描述
statusCode	number	业务状态码，可以通过此状态码判断操作是否成功，200 表示成功。
message	string	描述信息
apiCode	number	细分错误码，可通过此错误码得到具体的错误类型。
data	IsUserExistsDto	响应数据

示例结果：

{
  "statusCode": 200,
  "message": "操作成功",
  "apiCode": 20001,
  "data": {
    "exists": true
  }
}

¶ 数据结构

¶ IsUserExistsDto

名称	类型	必填	描述
exists	boolean	是	用户是否存在。示例值： `true`