@cloudbase/js-sdk 2.24.5 → 2.24.7

package/index.d.ts

@@ -28,6 +28,7 @@ import type {
   ResendReq,
   SetSessionReq,
   DeleteMeReq,
+  SignUpRes
 } from '@cloudbase/auth';
 import { AI } from '@cloudbase/ai';
 import { CloudbaseAdapter, ResponseObject } from '@cloudbase/adapter-interface'
@@ -718,7 +719,7 @@ declare namespace cloudbase.auth {
     /**
      * 获取当前登录的用户信息-同步操作
      *
-     * {@link https://docs.cloudbase.net/api-reference/webv3/authentication.html#auth-hasloginstate}
+     * {@link https://docs.cloudbase.net/api-reference/webv2/authentication#authhasloginstate}
      *
      * @example
      * ```javascript
@@ -732,7 +733,7 @@ declare namespace cloudbase.auth {
      */
     currentUser: IUser | null
     /**
-     * 获取当前登录的用户信息-异步操作，文档 {@link https://docs.cloudbase.net/api-reference/webv3/authentication#authgetcurrentuser}
+     * 获取当前登录的用户信息-异步操作，文档 {@link https://docs.cloudbase.net/api-reference/webv2/authentication#authgetcurrentuser}
      *
      * @example
      * ```javascript
@@ -750,7 +751,7 @@ declare namespace cloudbase.auth {
     /**
      * 绑定手机号码
      *
-     * 文档 {@link https://docs.cloudbase.net/api-reference/webv3/authentication#authbindphonenumber}
+     * 文档 {@link https://docs.cloudbase.net/api-reference/webv2/authentication#authbindphonenumber}
      *
      * @param params
      */
@@ -758,7 +759,7 @@ declare namespace cloudbase.auth {
     /**
      * 绑定邮箱
      *
-     * 文档 {@link https://docs.cloudbase.net/api-reference/webv3/authentication#authbindemail}
+     * 文档 {@link https://docs.cloudbase.net/api-reference/webv2/authentication#authbindemail}
      *
      * @param params
      */
@@ -766,7 +767,7 @@ declare namespace cloudbase.auth {
     /**
      * 解除三方绑定
      *
-     * 文档 {@link https://docs.cloudbase.net/api-reference/webv3/authentication#authunbindprovider}
+     * 文档 {@link https://docs.cloudbase.net/api-reference/webv2/authentication#authunbindprovider}
      *
      * @param params
      */
@@ -775,7 +776,7 @@ declare namespace cloudbase.auth {
     /**
      * 验证码验证
      *
-     * 文档 {@link https://docs.cloudbase.net/api-reference/webv3/authentication#authverify}
+     * 文档 {@link https://docs.cloudbase.net/api-reference/webv2/authentication#authverify}
      *
      * @param params
      */
@@ -783,7 +784,7 @@ declare namespace cloudbase.auth {
     /**
      * 获取验证码
      *
-     * 文档 {@link https://docs.cloudbase.net/api-reference/webv3/authentication#authgetverification}
+     * 文档 {@link https://docs.cloudbase.net/api-reference/webv2/authentication#authgetverification}
      *
      * @param params
      * @param options
@@ -793,36 +794,34 @@ declare namespace cloudbase.auth {
      * 匿名登录
      *
      *
-     * 文档 {@link https://docs.cloudbase.net/api-reference/webv3/authentication#authsigninanonymously}
+     * 文档 {@link https://docs.cloudbase.net/api-reference/webv2/authentication#authsigninanonymously}
      *
      */
-    signInAnonymously(data?: { provider_token?: string }): Promise<ILoginState>
+    signInAnonymously(data?: { provider_token?: string }): Promise<SignInRes>
     /**
      * 小程序匿名登录
      *
-     * 文档 {@link https://docs.cloudbase.net/api-reference/webv3/authentication#authsigninanonymouslyinwx}
-     *
      * @param params
      */
     signInAnonymouslyInWx(params?: { useWxCloud?: boolean }): Promise<ILoginState>
     /**
      * 小程序绑定OpenID
      *
-     * 文档 {@link https://docs.cloudbase.net/api-reference/webv3/authentication#authbindopenid}
+     * 文档 {@link https://docs.cloudbase.net/api-reference/webv2/authentication#authbindopenid}
      *
      */
     bindOpenId(): Promise<void>
     /**
      * 小程序unionId静默登录
      *
-     * 文档 {@link https://docs.cloudbase.net/api-reference/webv3/authentication#authsigninwithunionid}
+     * 文档 {@link https://docs.cloudbase.net/api-reference/webv2/authentication#authsigninwithunionid}
      *
      */
     signInWithUnionId(): Promise<ILoginState>
     /**
      * 短信验证码登录
      *
-     * 文档 {@link https://docs.cloudbase.net/api-reference/webv3/authentication#authsigninwithsms}
+     * 文档 {@link https://docs.cloudbase.net/api-reference/webv2/authentication#authsigninwithsms}
      *
      * @param params
      */
@@ -835,7 +834,7 @@ declare namespace cloudbase.auth {
     /**
      * 邮箱验证码登录
      *
-     * 文档 {@link https://docs.cloudbase.net/api-reference/webv3/authentication#authsigninwithemail}
+     * 文档 {@link https://docs.cloudbase.net/api-reference/webv2/authentication#authsigninwithemail}
      *
      * @param params
      */
@@ -848,55 +847,34 @@ declare namespace cloudbase.auth {
     /**
      * 设置获取自定义登录 ticket 的函数
      *
-     * 文档 {@link https://docs.cloudbase.net/api-reference/webv3/authentication#authsetcustomsignfunc}
+     * 文档 {@link https://docs.cloudbase.net/api-reference/webv2/authentication#authsetcustomsignfunc}
      *
      *
      * @param getTickFn
      */
     setCustomSignFunc(getTickFn: authModels.GetCustomSignTicketFn): void
-    /**
-     * 使用自定义登录 ticket 登录
-     *
-     * 文档 {@link https://docs.cloudbase.net/api-reference/webv3/authentication#authsigninwithcustomticket}
-     *
-     * @param getTickFn
-     */
-    signInWithCustomTicket(getTickFn?: authModels.GetCustomSignTicketFn): Promise<ILoginState>
-    /**
-     * 用户登录，目前支持手机号，邮箱，用户名密码登录
-     *
-     * 文档 {@link https://docs.cloudbase.net/api-reference/webv3/authentication#authsignin}
-     */
-    signIn(params: authModels.SignInRequest): Promise<ILoginState>
-    /**
-     * 用户注册，目前支持手机号验证码注册，邮箱验证码注册
-     *
-     * 文档 {@link https://docs.cloudbase.net/api-reference/webv3/authentication#authsignup}
-     */
-    signUp(params: authModels.SignUpRequest): Promise<ILoginState>
     /**
      * 设置密码（已登录状态下，更新用户密码）
      *
-     * 文档 {@link https://docs.cloudbase.net/api-reference/webv3/authentication#authsetpassword}
+     * 文档 {@link https://docs.cloudbase.net/api-reference/webv2/authentication#authsetpassword}
      *
      */
     setPassword(params: authModels.SetPasswordRequest): Promise<void>
     /**
      * 获取用户信息
      *
-     * 文档 {@link https://docs.cloudbase.net/api-reference/webv3/authentication#authgetuserinfo}
+     * 文档 {@link https://docs.cloudbase.net/api-reference/webv2/authentication#authgetuserinfo}
      */
     getUserInfo(): Promise<IUserInfo>
     /**
      * 获取微搭插件用户信息
      *
-     * 文档 {@link https://docs.cloudbase.net/api-reference/webv3/authentication#authgetwedauserinfo}
      */
     getWedaUserInfo(): Promise<any>
     /**
      * 更新用户基本信息
      *
-     * 文档 {@link https://docs.cloudbase.net/api-reference/webv3/authentication#authupdateuserbasicinfo}
+     * 文档 {@link https://docs.cloudbase.net/api-reference/webv2/authentication#authupdateuserbasicinfo}
      *
      * @param params
      */
@@ -904,7 +882,7 @@ declare namespace cloudbase.auth {
     /**
      * 获取本地登录态-同步操作
      *
-     * {@link https://docs.cloudbase.net/api-reference/webv3/authentication#authhasloginstate}
+     * {@link https://docs.cloudbase.net/api-reference/webv2/authentication#authhasloginstate}
      *
      * @example
      * ```javascript
@@ -920,7 +898,7 @@ declare namespace cloudbase.auth {
     /**
      * 获取本地登录态-异步操作
      *
-     * {@link https://docs.cloudbase.net/api-reference/webv3/authentication.html#auth-getloginstate}
+     * {@link https://docs.cloudbase.net/api-reference/webv2/authentication.html#auth-getloginstate}
      *
      * @example
      * ```javascript
@@ -942,46 +920,44 @@ declare namespace cloudbase.auth {
     /**
      * 为已有账户绑定第三方账户
      *
-     * 文档 {@link https://docs.cloudbase.net/api-reference/webv3/authentication#authbindwithprovider}
+     * 文档 {@link https://docs.cloudbase.net/api-reference/webv2/authentication#authbindwithprovider}
      */
     bindWithProvider(params: authModels.BindWithProviderRequest): Promise<void>
     /**
      * 查询用户（自定义登录场景和匿名登录场景，不支持使用该接口查询用户信息）
      *
-     * 文档 {@link https://docs.cloudbase.net/api-reference/webv3/authentication#authqueryuser}
+     * 文档 {@link https://docs.cloudbase.net/api-reference/webv2/authentication#authqueryuser}
      *
      */
     queryUser(queryObj: authModels.QueryUserProfileRequest): Promise<authModels.QueryUserProfileResponse>
     /**
      * 获取当前登录用户的访问凭证
      *
-     * 文档 {@link https://docs.cloudbase.net/api-reference/webv3/authentication#authgetaccesstoken}
+     * 文档 {@link https://docs.cloudbase.net/api-reference/webv2/authentication#authgetaccesstoken}
      */
     getAccessToken(): Promise<{ accessToken: string; env: string }>
     /**
      * 提供第三方平台登录 token
      *
-     * 文档 {@link https://docs.cloudbase.net/api-reference/webv3/authentication#authgrantprovidertoken}
+     * 文档 {@link https://docs.cloudbase.net/api-reference/webv2/authentication#authgrantprovidertoken}
      */
     grantProviderToken(params: authModels.GrantProviderTokenRequest): Promise<authModels.GrantProviderTokenResponse>
     patchProviderToken(params: authModels.PatchProviderTokenRequest): Promise<authModels.PatchProviderTokenResponse>
     /**
      * 第三方平台登录
      *
-     * 文档 {@link https://docs.cloudbase.net/api-reference/webv3/authentication#authsigninwithprovider}
+     * 文档 {@link https://docs.cloudbase.net/api-reference/webv2/authentication#authsigninwithprovider}
      */
     signInWithProvider(params: authModels.SignInWithProviderRequest): Promise<ILoginState>
     /**
      * 微信登录
-     *
-     * 文档 {@link https://docs.cloudbase.net/api-reference/webv3/authentication#authsigninwithwechat}
      */
     signInWithWechat(params?: any): Promise<ILoginState>
     grantToken(params: authModels.GrantTokenRequest): Promise<ILoginState>
     /**
      * 生成第三方平台授权 Uri （如微信二维码扫码授权网页）
      *
-     * 文档 {@link https://docs.cloudbase.net/api-reference/webv3/authentication#authgenproviderredirecturi}
+     * 文档 {@link https://docs.cloudbase.net/api-reference/webv2/authentication#authgenproviderredirecturi}
      */
     genProviderRedirectUri(
       params: authModels.GenProviderRedirectUriRequest,
@@ -989,32 +965,32 @@ declare namespace cloudbase.auth {
     /**
      * 重置密码（用户忘记密码无法登录时，可使用该接口强制设置密码）
      *
-     * 文档 {@link https://docs.cloudbase.net/api-reference/webv3/authentication#authresetpassword}
+     * 文档 {@link https://docs.cloudbase.net/api-reference/webv2/authentication#authresetpassword}
      */
     resetPassword(params: authModels.ResetPasswordRequest): Promise<void>
     deviceAuthorize(params: authModels.DeviceAuthorizeRequest): Promise<authModels.DeviceAuthorizeResponse>
     /**
      * 通过 sudo 接口获取高级操作权限，如修改用户密码，修改手机号，邮箱等操作
      *
-     * 文档 {@link https://docs.cloudbase.net/api-reference/webv3/authentication#authsudo}
+     * 文档 {@link https://docs.cloudbase.net/api-reference/webv2/authentication#authsudo}
      */
     sudo(params: authModels.SudoRequest): Promise<authModels.SudoResponse>
     /**
      * 删除用户
      *
-     * 文档 {@link https://docs.cloudbase.net/api-reference/webv3/authentication#authdeleteme}
+     * 文档 {@link https://docs.cloudbase.net/api-reference/webv2/authentication#authdeleteme}
      */
     deleteMe(params: authModels.WithSudoRequest): Promise<authModels.UserProfile>
     /**
      * 获取第三方绑定列表
      *
-     * 文档 {@link https://docs.cloudbase.net/api-reference/webv3/authentication#authgetproviders}
+     * 文档 {@link https://docs.cloudbase.net/api-reference/webv2/authentication#authgetproviders}
      */
     getProviders(): Promise<authModels.UserProfileProvider>
     /**
      * 用于查询用户是否为匿名登录状态
      *
-     * 文档 {@link https://docs.cloudbase.net/api-reference/webv3/authentication#authloginscope}
+     * 文档 {@link https://docs.cloudbase.net/api-reference/webv2/authentication#authloginscope}
      */
     loginScope(): Promise<string>
     loginGroups(): Promise<string[]>
@@ -1023,51 +999,42 @@ declare namespace cloudbase.auth {
     /**
      * 强制刷新token
      *
-     * 文档 {@link https://docs.cloudbase.net/api-reference/webv3/authentication#authrefreshtokenforce}
-     *
      * @param params
      */
     refreshTokenForce(params: { version?: string }): Promise<authModels.Credentials>
     /**
      * 获取身份信息
      *
-     * 文档 {@link https://docs.cloudbase.net/api-reference/webv3/authentication#authgetcredentials}
+     * 文档 {@link https://docs.cloudbase.net/api-reference/webv2/authentication#authgetcredentials}
      */
     getCredentials(): Promise<authModels.Credentials>
     /**
      * 写入身份信息
      *
-     * 文档 {@link https://docs.cloudbase.net/api-reference/webv3/authentication#authsetcredentials}
-     *
      * @param credentials
      */
     setCredentials(credentials: authModels.Credentials): Promise<void>
     /**
      * 获取身份源类型
      *
-     * 文档 {@link https://docs.cloudbase.net/api-reference/webv3/authentication#authgetprovidersubtype}
      */
     getProviderSubType(): Promise<authModels.ProviderSubType>
     /**
      * 创建验证码数据
      *
-     * 文档 {@link https://docs.cloudbase.net/api-reference/webv3/authentication#authcreatecaptchadata}
-     *
      * @param params
      */
     createCaptchaData(params: { state: string; redirect_uri?: string }): Promise<any>
     /**
      * 验证验证码数据
      *
-     * 文档 {@link https://docs.cloudbase.net/api-reference/webv3/authentication#authverifycaptchadata}
-     *
      * @param params
      */
     verifyCaptchaData(params: { token: string; key: string }): Promise<any>
     /**
      * 修改密码
      *
-     * 文档 {@link https://docs.cloudbase.net/api-reference/webv3/authentication#authmodifypassword}
+     * 文档 {@link https://docs.cloudbase.net/api-reference/webv2/authentication#authmodifypassword}
      *
      * @param params
      */
@@ -1075,7 +1042,7 @@ declare namespace cloudbase.auth {
     /**
      * 未登录状态修改密码
      *
-     * 文档 {@link https://docs.cloudbase.net/api-reference/webv3/authentication#authmodifypasswordwithoutlogin}
+     * 文档 {@link https://docs.cloudbase.net/api-reference/webv2/authentication#authmodifypasswordwithoutlogin}
      *
      * @param params
      */
@@ -1083,31 +1050,15 @@ declare namespace cloudbase.auth {
     /**
      * 获取用户行为日志
      *
-     * 文档 {@link https://docs.cloudbase.net/api-reference/webv3/authentication#authgetuserbehaviorlog}
+     * 文档 {@link https://docs.cloudbase.net/api-reference/webv2/authentication#authgetuserbehaviorlog}
      *
      * @param params
      */
     getUserBehaviorLog(params: authModels.GetUserBehaviorLog): Promise<authModels.GetUserBehaviorLogRes>
-    /**
-     * 退出登录，请注意，匿名登录不支持退出
-     *
-     * {@link https://docs.cloudbase.net/api-reference/webv3/authentication#authsignout}
-     *
-     * @example
-     * ```javascript
-     * const app = cloudbase.init({
-     *   env: "xxxx-yyy"
-     * });
-     * app.auth().signOut().then(()=>{});
-     * ```
-     *
-     * @return Promise
-     */
-    signOut(): Promise<void | { redirect_uri?: string }>
     /**
      * 检查用户名是否被绑定过
      *
-     * {@link https://docs.cloudbase.net/api-reference/webv3/authentication.html#authisusernameregistered}
+     * {@link https://docs.cloudbase.net/api-reference/webv2/authentication.html#authisusernameregistered}
      *
      * @example
      * ```javascript
@@ -1130,11 +1081,54 @@ declare namespace cloudbase.auth {
     getMiniProgramQrCodeStatus(
       params: authModels.GetMiniProgramQrCodeStatusRequest,
     ): Promise<authModels.GetMiniProgramQrCodeStatusResponse>
-    toDefaultLoginPage(params?: authModels.ToDefaultLoginPage): Promise<void>
+    /**
+     * 跳转到默认登录页
+     * 文档 {@link https://docs.cloudbase.net/api-reference/webv2/authentication#authtodefaultloginpage}
+     * @param params 
+     */
+    toDefaultLoginPage(params?: authModels.ToDefaultLoginPage): Promise<CommonRes>
+
+    
+    /**
+     * 退出登录
+     *
+     * {@link https://docs.cloudbase.net/api-reference/webv3/authentication#signout}
+     *
+     * @example
+     * ```javascript
+     * const app = cloudbase.init({
+     *   env: "xxxx-yyy"
+     * });
+     * app.auth.signOut().then(()=>{});
+     * ```
+     *
+     * @return Promise
+     */
+    signOut(params?: authModels.SignoutRequest): Promise<void | authModels.SignoutReponse>
+    /**
+     * 使用自定义登录 ticket 登录
+     *
+     * 文档 {@link https://docs.cloudbase.net/api-reference/webv3/authentication#signinwithcustomticket}
+     *
+     * @param getTickFn
+     */
+    signInWithCustomTicket(getTickFn?: authModels.GetCustomSignTicketFn): Promise<ILoginState>
+    /**
+     * 用户登录，目前支持手机号，邮箱，用户名密码登录
+     *
+     * 文档 {@link https://docs.cloudbase.net/api-reference/webv3/authentication#signin}
+     */
+    signIn(params: authModels.SignInRequest): Promise<ILoginState>
+    /**
+     * 用户注册，目前支持手机号验证码注册，邮箱验证码注册
+     *
+     * 文档 {@link https://docs.cloudbase.net/api-reference/webv3/authentication#signup}
+     */
+    signUp(params: authModels.SignUpRequest): Promise<SignUpRes>
     /**
      * 监听认证状态变化
      *
-     * 文档 {@link https://docs.cloudbase.net/api-reference/webv3/authentication#authonauthstatechange}
+     * 文档 {@link https://docs.cloudbase.net/api-reference/webv3/authentication#onauthstatechange}
      *
      * @param callback
      */
@@ -1142,7 +1136,7 @@ declare namespace cloudbase.auth {
     /**
      * 使用用户名和密码登录
      *
-     * 文档 {@link https://docs.cloudbase.net/api-reference/webv3/authentication#authsigninwithpassword}
+     * 文档 {@link https://docs.cloudbase.net/api-reference/webv3/authentication#signinwithpassword}
      *
      * @param params
      */
@@ -1150,7 +1144,7 @@ declare namespace cloudbase.auth {
     /**
      * 使用第三方平台 ID Token 登录
      *
-     * 文档 {@link https://docs.cloudbase.net/api-reference/webv3/authentication#authsigninwithidtoken}
+     * 文档 {@link https://docs.cloudbase.net/api-reference/webv3/authentication#signinwithidtoken}
      *
      * @param params
      */
@@ -1158,7 +1152,7 @@ declare namespace cloudbase.auth {
     /**
      * 使用一次性密码（OTP）登录
      *
-     * 文档 {@link https://docs.cloudbase.net/api-reference/webv3/authentication#authsigninwithotp}
+     * 文档 {@link https://docs.cloudbase.net/api-reference/webv3/authentication#signinwithotp}
      *
      * @param params
      */
@@ -1166,7 +1160,7 @@ declare namespace cloudbase.auth {
     /**
      * 校验第三方平台授权登录回调
      *
-     * 文档 {@link https://docs.cloudbase.net/api-reference/webv3/authentication#authverifyoauth}
+     * 文档 {@link https://docs.cloudbase.net/api-reference/webv3/authentication#verifyoauth}
      *
      * @param params
      */
@@ -1174,21 +1168,21 @@ declare namespace cloudbase.auth {
     /**
      * 生成第三方平台授权 Uri
      *
-     * 文档 {@link https://docs.cloudbase.net/api-reference/webv3/authentication#authsigninwithoauth}
+     * 文档 {@link https://docs.cloudbase.net/api-reference/webv3/authentication#signinwithoauth}
      *
      * @param params
      */
     signInWithOAuth(params: SignInWithOAuthReq): Promise<SignInOAuthRes>
     /**
-     * 获取用户声明信息
+     * 获取当前访问令牌中的声明信息
      *
-     * 文档 {@link https://docs.cloudbase.net/api-reference/webv3/authentication#authgetclaims}
+     * 文档 {@link https://docs.cloudbase.net/api-reference/webv3/authentication#getclaims}
      */
     getClaims(): Promise<GetClaimsRes>
     /**
-     * 通过邮箱或手机号重置密码
+     * 通过邮箱重置密码
      *
-     * 文档 {@link https://docs.cloudbase.net/api-reference/webv3/authentication#authresetpasswordforemail}
+     * 文档 {@link https://docs.cloudbase.net/api-reference/webv3/authentication#resetpasswordforemail}
      *
      * @param emailOrPhone
      * @param options
@@ -1197,7 +1191,7 @@ declare namespace cloudbase.auth {
     /**
      * 通过旧密码重置密码
      *
-     * 文档 {@link https://docs.cloudbase.net/api-reference/webv3/authentication#authresetpasswordforold}
+     * 文档 {@link https://docs.cloudbase.net/api-reference/webv3/authentication#resetpasswordforold}
      *
      * @param params
      */
@@ -1205,7 +1199,7 @@ declare namespace cloudbase.auth {
     /**
      * 验证一次性密码（OTP）
      *
-     * 文档 {@link https://docs.cloudbase.net/api-reference/webv3/authentication#authverifyotp}
+     * 文档 {@link https://docs.cloudbase.net/api-reference/webv3/authentication#verifyotp}
      *
      * @param params
      */
@@ -1213,13 +1207,13 @@ declare namespace cloudbase.auth {
     /**
      * 获取当前会话
      *
-     * 文档 {@link https://docs.cloudbase.net/api-reference/webv3/authentication#authgetsession}
+     * 文档 {@link https://docs.cloudbase.net/api-reference/webv3/authentication#getsession}
      */
     getSession(): Promise<SignInRes>
     /**
      * 刷新会话
      *
-     * 文档 {@link https://docs.cloudbase.net/api-reference/webv3/authentication#authrefreshsession}
+     * 文档 {@link https://docs.cloudbase.net/api-reference/webv3/authentication#refreshsession}
      *
      * @param refresh_token
      */
@@ -1227,33 +1221,33 @@ declare namespace cloudbase.auth {
     /**
      * 获取当前用户详细信息
      *
-     * 文档 {@link https://docs.cloudbase.net/api-reference/webv3/authentication#authgetuser}
+     * 文档 {@link https://docs.cloudbase.net/api-reference/webv3/authentication#getuser}
      */
     getUser(): Promise<GetUserRes>
     /**
      * 刷新用户信息
      *
-     * 文档 {@link https://docs.cloudbase.net/api-reference/webv3/authentication#authrefreshuser}
+     * 文档 {@link https://docs.cloudbase.net/api-reference/webv3/authentication#refreshuser}
      */
     refreshUser(): Promise<CommonRes>
     /**
      * 更新用户信息
      *
-     * 文档 {@link https://docs.cloudbase.net/api-reference/webv3/authentication#authupdateuser}
+     * 文档 {@link https://docs.cloudbase.net/api-reference/webv3/authentication#updateuser}
      *
      * @param params
      */
     updateUser(params: UpdateUserReq): Promise<GetUserRes | UpdateUserWithVerificationRes>
     /**
-     * 获取所有身份源
+     * 获取已绑定的身份源
      *
-     * 文档 {@link https://docs.cloudbase.net/api-reference/webv3/authentication#authgetuseridentities}
+     * 文档 {@link https://docs.cloudbase.net/api-reference/webv3/authentication#getuseridentities}
      */
     getUserIdentities(): Promise<GetUserIdentitiesRes>
     /**
      * 绑定身份源到当前用户
      *
-     * 文档 {@link https://docs.cloudbase.net/api-reference/webv3/authentication#authlinkidentity}
+     * 文档 {@link https://docs.cloudbase.net/api-reference/webv3/authentication#linkidentity}
      *
      * @param params
      */
@@ -1261,7 +1255,7 @@ declare namespace cloudbase.auth {
     /**
      * 解绑身份源
      *
-     * 文档 {@link https://docs.cloudbase.net/api-reference/webv3/authentication#authunlinkidentity}
+     * 文档 {@link https://docs.cloudbase.net/api-reference/webv3/authentication#unlinkidentity}
      *
      * @param params
      */
@@ -1269,13 +1263,13 @@ declare namespace cloudbase.auth {
     /**
      * 重新认证
      *
-     * 文档 {@link https://docs.cloudbase.net/api-reference/webv3/authentication#authreauthenticate}
+     * 文档 {@link https://docs.cloudbase.net/api-reference/webv3/authentication#reauthenticate}
      */
     reauthenticate(): Promise<ReauthenticateRes>
     /**
      * 重新发送验证码
      *
-     * 文档 {@link https://docs.cloudbase.net/api-reference/webv3/authentication#authresend}
+     * 文档 {@link https://docs.cloudbase.net/api-reference/webv3/authentication#resend}
      *
      * @param params
      */
@@ -1283,7 +1277,7 @@ declare namespace cloudbase.auth {
     /**
      * 使用 access_token 和 refresh_token 设置会话
      *
-     * 文档 {@link https://docs.cloudbase.net/api-reference/webv3/authentication#authsetsession}
+     * 文档 {@link https://docs.cloudbase.net/api-reference/webv3/authentication#setsession}
      *
      * @param params
      */
@@ -1291,7 +1285,7 @@ declare namespace cloudbase.auth {
     /**
      * 删除当前用户
      *
-     * 文档 {@link https://docs.cloudbase.net/api-reference/webv3/authentication#authdeleteuser}
+     * 文档 {@link https://docs.cloudbase.net/api-reference/webv3/authentication#deleteuser}
      *
      * @param params
      */
@@ -1299,7 +1293,7 @@ declare namespace cloudbase.auth {
     /**
      * 小程序 openId 静默登录
      *
-     * 文档 {@link https://docs.cloudbase.net/api-reference/webv3/authentication#authsigninwithopenid}
+     * 文档 {@link https://docs.cloudbase.net/api-reference/webv3/authentication#signinwithopenid}
      *
      * @param params
      */
@@ -1307,7 +1301,7 @@ declare namespace cloudbase.auth {
     /**
      * 小程序手机号授权登录
      *
-     * 文档 {@link https://docs.cloudbase.net/api-reference/webv3/authentication#authsigninwithphoneauth}
+     * 文档 {@link https://docs.cloudbase.net/api-reference/webv3/authentication#signinwithphoneauth}
      *
      * @param params
      */