¶ 删除用户实名认证信息

Update time: 2025-07-23 07:34:21

通过用户 ID，删除用户实名认证信息，可以选择指定用户 ID 类型等。

¶ 请求参数

名称	类型	必填	默认值	描述	示例值
userId	string	是	-	用户 ID。	`6229ffaxxxxxxxxcade3e3d9`
options	ResetUserPrincipalAuthenticationInfoOptionsDto	否	-	可选参数。

¶ 示例代码

import { ManagementClient } from "@genauth/nodejs";
// 在 Node.js 中引用：
// const { ManagementClient } = require('@genauth/nodejs');

const managementClient = new ManagementClient({
  accessKeyId: "GEN_AUTH_USERPOOL_ID",
  accessKeySecret: "GEN_AUTH_USERPOOL_SECRET",
});

(async () => {
  const result = await managementClient.resetUserPrincipalAuthenticationInfo({
    userId: "6229ffaxxxxxxxxcade3e3d9",
    options: {
      userIdType: "user_id",
    },
  });
})();

¶ 请求响应

类型： IsSuccessRespDto

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

示例结果：

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

¶ 数据结构

¶ ResetUserPrincipalAuthenticationInfoOptionsDto

名称	类型	必填	描述
userIdType	string	否	用户 ID 类型，可以指定为用户 ID、手机号、邮箱、用户名和 externalId。。枚举值：`user_id`,`external_id`,`phone`,`email`,`username`

¶ IsSuccessDto

名称	类型	必填	描述
success	boolean	是	操作是否成功。示例值： `true`

Previous article: Get User Real-name Authentication Information Next article: Get User Department List