@ohos.userIAM.userAuth (用户认证)

提供用户认证能力，可应用于设备解锁、支付、应用登录等身份认证场景。

说明： 本模块首批接口从API version 6开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。

导入模块

import userIAM_userAuth from '@ohos.userIAM.userAuth';

WindowModeType¹⁰⁺

用户认证界面的显示类型。

系统能力：SystemCapability.UserIAM.UserAuth.Core

系统接口: 此接口为系统接口。

名称	值	说明
DIALOG_BOX	1	弹框类型。
FULLSCREEN	2	全屏类型。

AuthParam¹⁰⁺

用户认证相关参数。

系统能力：SystemCapability.UserIAM.UserAuth.Core

名称	类型	必填	说明
challenge	Uint8Array	是	挑战值，用来防重放攻击。最大长度为32字节，可传Uint8Array([])。
authType	UserAuthType[]	是	认证类型列表，用来指定用户认证界面提供的认证方法。
authTrustLevel	AuthTrustLevel	是	认证信任等级。

WidgetParam¹⁰⁺

用户认证界面配置相关参数。

系统能力：SystemCapability.UserIAM.UserAuth.Core

名称	类型	必填	说明
title	string	是	用户认证界面的标题，最大长度为500字符。
navigationButtonText	string	否	导航按键的说明文本，最大长度为60字符。仅在单指纹、单人脸场景下支持。
windowMode	WindowModeType	否	代表用户认证界面的显示类型，默认值为WindowModeType.DIALOG_BOX。系统接口: 此接口为系统接口。

UserAuthResult¹⁰⁺

用户认证结果。当认证结果为成功时，返回认证类型和认证通过的令牌信息。

系统能力：SystemCapability.UserIAM.UserAuth.Core

名称	类型	必填	说明
result	number	是	用户认证结果。若成功返回SUCCESS，若失败返回相应错误码，参见UserAuthResultCode。
token	Uint8Array	否	当认证结果为成功时，返回认证通过的令牌信息。
authType	UserAuthType	否	当认证结果为成功时，返回认证类型。

IAuthCallback¹⁰⁺

返回认证结果的回调对象。

onResult¹⁰⁺

onResult(result: UserAuthResult): void

回调函数，返回认证结果。

系统能力：SystemCapability.UserIAM.UserAuth.Core

参数：

参数名	类型	必填	说明
result	UserAuthResult	是	认证结果。

示例：

import userAuth from '@ohos.userIAM.userAuth';

const authParam : userAuth.AuthParam = {
  challenge: new Uint8Array([49, 49, 49, 49, 49, 49]),
  authType: [userAuth.UserAuthType.PIN],
  authTrustLevel: userAuth.AuthTrustLevel.ATL1,
};
const widgetParam :userAuth.WidgetParam = {
  title: '请输入密码',
};
try {
  let userAuthInstance = userAuth.getUserAuthInstance(authParam, widgetParam);
  console.log('get userAuth instance success');
  userAuthInstance.on('result', {
    onResult (result) {
      console.log('userAuthInstance callback result = ' + JSON.stringify(result));
    }
  });
  console.log('auth on success');
} catch (error) {
  console.error('auth catch error: ' + JSON.stringify(error));
}

UserAuthInstance¹⁰⁺

用于执行用户身份认证，并支持使用统一用户身份认证组件。使用以下接口前，都需要先通过getUserAuthInstance方法获取UserAuthInstance对象。

on¹⁰⁺

on(type: 'result', callback: IAuthCallback): void

订阅用户身份认证结果。

系统能力：SystemCapability.UserIAM.UserAuth.Core

参数：

参数名	类型	必填	说明
type	'result'	是	订阅事件类型，表明该事件用来返回认证结果。
callback	IAuthCallback	是	认证接口的回调函数，用于返回认证结果。

错误码：

以下错误码的详细介绍请参见用户认证错误码。

错误码ID	错误信息
401	Incorrect parameters.
12500002	General operation error.

示例：

import userAuth from '@ohos.userIAM.userAuth';

const authParam : userAuth.AuthParam = {
  challenge: new Uint8Array([49, 49, 49, 49, 49, 49]),
  authType: [userAuth.UserAuthType.PIN],
  authTrustLevel: userAuth.AuthTrustLevel.ATL1,
};
const widgetParam :userAuth.WidgetParam = {
  title: '请输入密码',
};
try {
  let userAuthInstance = userAuth.getUserAuthInstance(authParam, widgetParam);
  console.log('get userAuth instance success');
  userAuthInstance.on('result', {
    onResult (result) {
      console.log('userAuthInstance callback result = ' + JSON.stringify(result));
    }
  });
  console.log('auth on success');
} catch (error) {
  console.error('auth catch error: ' + JSON.stringify(error));
}

off¹⁰⁺

off(type: 'result', callback?: IAuthCallback): void

取消订阅用户身份认证结果。

说明：需要使用已经成功订阅事件的UserAuthInstance对象调用该接口进行取消订阅。

系统能力：SystemCapability.UserIAM.UserAuth.Core

参数：

参数名	类型	必填	说明
type	'result'	是	订阅事件类型，表明该事件用来返回认证结果。
callback	IAuthCallback	否	认证接口的回调函数，用于返回认证结果。

错误码：

以下错误码的详细介绍请参见用户认证错误码。

错误码ID	错误信息
401	Incorrect parameters.
12500002	General operation error.

示例：

import userAuth from '@ohos.userIAM.userAuth';

const authParam : userAuth.AuthParam = {
  challenge: new Uint8Array([49, 49, 49, 49, 49, 49]),
  authType: [userAuth.UserAuthType.PIN],
  authTrustLevel: userAuth.AuthTrustLevel.ATL1,
};
const widgetParam :userAuth.WidgetParam = {
  title: '请输入密码',
};
try {
  let userAuthInstance = userAuth.getUserAuthInstance(authParam, widgetParam);
  console.log('get userAuth instance success');
  userAuthInstance.off('result', {
    onResult (result) {
      console.log('auth off result: ' + JSON.stringify(result));
    }
  });
  console.log('auth off success');
} catch (error) {
  console.error('auth catch error: ' + JSON.stringify(error));
}

start¹⁰⁺

start(): void

开始认证。

需要权限：ohos.permission.ACCESS_BIOMETRIC

系统能力：SystemCapability.UserIAM.UserAuth.Core

错误码：

以下错误码的详细介绍请参见用户认证错误码。

错误码ID	错误信息
201	Permission verification failed.
401	Incorrect parameters.
12500001	Authentication failed.
12500002	General operation error.
12500003	The operation is canceled.
12500004	The operation is time-out.
12500005	The authentication type is not supported.
12500006	The authentication trust level is not supported.
12500007	The authentication task is busy.
12500009	The authenticator is locked.
12500010	The type of credential has not been enrolled.
12500011	The authentication is canceled from widget's navigation button.

示例：

import userAuth from '@ohos.userIAM.userAuth';

const authParam : userAuth.AuthParam = {
  challenge: new Uint8Array([49, 49, 49, 49, 49, 49]),
  authType: [userAuth.UserAuthType.PIN],
  authTrustLevel: userAuth.AuthTrustLevel.ATL1,
};
const widgetParam :userAuth.WidgetParam = {
  title: '请输入密码',
};
try {
  let userAuthInstance = userAuth.getUserAuthInstance(authParam, widgetParam);
  console.log('get userAuth instance success');
  userAuthInstance.start();
  console.log('auth start success');
} catch (error) {
  console.error('auth catch error: ' + JSON.stringify(error));
}

cancel¹⁰⁺

cancel(): void

取消认证。

说明：此时UserAuthInstance需要是正在进行认证的对象。

需要权限：ohos.permission.ACCESS_BIOMETRIC

系统能力：SystemCapability.UserIAM.UserAuth.Core

错误码：

错误码ID	错误信息
201	Permission verification failed.
401	Incorrect parameters.
12500002	General operation error.

示例：

import userAuth from '@ohos.userIAM.userAuth';

const authParam : userAuth.AuthParam = {
  challenge: new Uint8Array([49, 49, 49, 49, 49, 49]),
  authType: [userAuth.UserAuthType.PIN],
  authTrustLevel: userAuth.AuthTrustLevel.ATL1,
};
const widgetParam :userAuth.WidgetParam = {
  title: '请输入密码',
};
try {
  let userAuthInstance = userAuth.getUserAuthInstance(authParam, widgetParam);
  console.log('get userAuth instance success');
  userAuthInstance.cancel();
  console.log('auth cancel success');
} catch (error) {
  console.error('auth catch error: ' + JSON.stringify(error));
}

getUserAuthInstance¹⁰⁺

getUserAuthInstance(authParam: AuthParam, widgetParam: WidgetParam): UserAuthInstance

获取UserAuthInstance对象，用于执行用户身份认证，并支持使用统一用户身份认证组件。

说明： 每个UserAuthInstance只能进行一次认证，若需要再次进行认证则需重新获取UserAuthInstance。

系统能力：SystemCapability.UserIAM.UserAuth.Core

参数：

参数名	类型	必填	说明
authParam	AuthParam	是	用户认证相关参数。
widgetParam	WidgetParam	是	用户认证界面配置相关参数。

返回值：

类型	说明
UserAuthInstance	支持用户界面的认证器对象。

错误码：

以下错误码的详细介绍请参见用户认证错误码。

错误码ID	错误信息
401	Incorrect parameters.
12500002	General operation error.
12500005	The authentication type is not supported.
12500006	The authentication trust level is not supported.

示例：

import userAuth from '@ohos.userIAM.userAuth';

const authParam : userAuth.AuthParam = {
  challenge: new Uint8Array([49, 49, 49, 49, 49, 49]),
  authType: [userAuth.UserAuthType.PIN],
  authTrustLevel: userAuth.AuthTrustLevel.ATL1,
};
const widgetParam :userAuth.WidgetParam = {
  title: '请输入密码',
};
try {
  let userAuthInstance = userAuth.getUserAuthInstance(authParam, widgetParam);
  console.log('get userAuth instance success');
} catch (error) {
  console.error('auth catch error: ' + JSON.stringify(error));
}

NoticeType¹⁰⁺

用户身份认证的通知类型。

系统能力：SystemCapability.UserIAM.UserAuth.Core

系统接口: 此接口为系统接口。

名称	值	说明
WIDGET_NOTICE	1	表示来自组件的通知。

sendNotice¹⁰⁺

sendNotice(noticeType: NoticeType, eventData: string): void

在使用统一身份认证组件进行用户身份认证时，用于接收来自统一身份认证组件的通知。

需要权限：ohos.permission.SUPPORT_USER_AUTH

系统能力：SystemCapability.UserIAM.UserAuth.Core

系统接口: 此接口为系统接口。

参数：

参数名	类型	必填	说明
noticeType	NoticeType	是	通知类型。
eventData	string	是	事件数据。

错误码：

以下错误码的详细介绍请参见用户认证错误码。

错误码ID	错误信息
201	Permission verification failed.
202	The caller is not a system application.
401	Incorrect parameters.
12500002	General operation error.

示例：

import userAuth from '@ohos.userIAM.userAuth';

interface  EventData {
  widgetContextId: number;
  event: string;
  version: string;
  payload: PayLoad;
}
interface PayLoad {
  type: Object[];
}
try {
  const eventData : EventData = {
    widgetContextId: 123456,
    event: 'EVENT_AUTH_TYPE_READY',
    version: '1',
    payload: {
      type: ['pin']
    } as PayLoad,
  };
  const jsonEventData = JSON.stringify(eventData);
  let noticeType = userAuth.NoticeType.WIDGET_NOTICE;
  userAuth.sendNotice(noticeType, jsonEventData);
  console.log('sendNotice success');
} catch (error) {
  console.error('sendNotice catch error: ' + JSON.stringify(error));
}

UserAuthWidgetMgr¹⁰⁺

组件管理接口，可将用身份认证组件注册到UserAuthWidgetMgr中，由UserAuthWidgetMgr进行管理、调度。

on¹⁰⁺

on(type: 'command', callback: IAuthWidgetCallback): void

身份认证组件订阅来自用户认证框架的命令。

系统能力：SystemCapability.UserIAM.UserAuth.Core

系统接口: 此接口为系统接口。

参数：

参数名	类型	必填	说明
type	'command'	是	订阅事件类型，表明该事件用于用户认证框架向身份认证组件发送命令。
callback	IAuthWidgetCallback	是	组件管理接口的回调函数，用于用户认证框架向身份认证组件发送命令。

错误码：

以下错误码的详细介绍请参见用户认证错误码。

错误码ID	错误信息
401	Incorrect parameters.
12500002	General operation error.

示例：

import userAuth from '@ohos.userIAM.userAuth';

const userAuthWidgetMgrVersion = 1;
try {
  let userAuthWidgetMgr = userAuth.getUserAuthWidgetMgr(userAuthWidgetMgrVersion);
  console.log('get userAuthWidgetMgr instance success');
  userAuthWidgetMgr.on('command', {
    sendCommand(cmdData) {
      console.log('The cmdData is ' + cmdData);
    }
  })
  console.log('subscribe authentication event success');
} catch (error) {
  console.error('userAuth widgetMgr catch error: ' + JSON.stringify(error));
}

off¹⁰⁺

off(type: 'command', callback?: IAuthWidgetCallback): void

身份认证组件取消订阅来自用户认证框架的命令。

系统能力：SystemCapability.UserIAM.UserAuth.Core

系统接口: 此接口为系统接口。

参数：

参数名	类型	必填	说明
type	'command'	是	订阅事件类型，表明该事件用于用户认证框架向身份认证组件发送命令。
callback	IAuthWidgetCallback	否	组件管理接口的回调函数，用于用户认证框架向身份认证组件发送命令。

错误码：

以下错误码的详细介绍请参见用户认证错误码。

错误码ID	错误信息
401	Incorrect parameters.
12500002	General operation error.

示例：

import userAuth from '@ohos.userIAM.userAuth';

const userAuthWidgetMgrVersion = 1;
try {
  let userAuthWidgetMgr = userAuth.getUserAuthWidgetMgr(userAuthWidgetMgrVersion);
  console.log('get userAuthWidgetMgr instance success');
  userAuthWidgetMgr.off('command', {
    sendCommand(cmdData) {
      console.log('The cmdData is ' + cmdData);
    }
  })
  console.log('cancel subscribe authentication event success');
} catch (error) {
  console.error('userAuth widgetMgr catch error: ' + JSON.stringify(error));
}

getUserAuthWidgetMgr¹⁰⁺

getUserAuthWidgetMgr(version: number): UserAuthWidgetMgr

获取UserAuthWidgetMgr对象，用于执行用户身份认证。

说明： 每个UserAuthInstance只能进行一次认证，若需要再次进行认证则需重新获取UserAuthInstance。

需要权限：ohos.permission.SUPPORT_USER_AUTH

系统能力：SystemCapability.UserIAM.UserAuth.Core

系统接口: 此接口为系统接口。

参数：

参数名	类型	必填	说明
version	number	是	表示认证组件的版本。

返回值：

类型	说明
UserAuthWidgetMgr	认证器对象。

错误码：

以下错误码的详细介绍请参见用户认证错误码。

错误码ID	错误信息
201	Permission verification failed.
202	The caller is not a system application.
401	Incorrect parameters.
12500002	General operation error.

示例：

import userAuth from '@ohos.userIAM.userAuth';

let userAuthWidgetMgrVersion = 1;
try {
  let userAuthWidgetMgr = userAuth.getUserAuthWidgetMgr(userAuthWidgetMgrVersion);
  console.log('get userAuthWidgetMgr instance success');
} catch (error) {
  console.error('userAuth widgetMgr catch error: ' + JSON.stringify(error));
}

IAuthWidgetCallback¹⁰⁺

认证组件通过该回调获取用户认证框架发送的命令。

sendCommand¹⁰⁺

sendCommand(cmdData: string): void

回调函数，用于用户认证框架向组件发送命令。

系统能力：SystemCapability.UserIAM.UserAuth.Core

系统接口: 此接口为系统接口。

参数：

参数名	类型	必填	说明
cmdData	string	是	用户身份认证框架向组件发送的命令。

示例：

import userAuth from '@ohos.userIAM.userAuth';

const userAuthWidgetMgrVersion = 1;
try {
  let userAuthWidgetMgr = userAuth.getUserAuthWidgetMgr(userAuthWidgetMgrVersion);
  console.log('get userAuthWidgetMgr instance success');
  userAuthWidgetMgr.on('command', {
    sendCommand(cmdData) {
      console.log('The cmdData is ' + cmdData);
    }
  })
  console.log('subscribe authentication event success');
} catch (error) {
  console.error('userAuth widgetMgr catch error: ' + JSON.stringify(error));
}

AuthResultInfo⁹⁺

表示认证结果信息。

系统能力：以下各项对应的系统能力均为SystemCapability.UserIAM.UserAuth.Core

名称	类型	必填	说明
result	number	是	认证结果。
token	Uint8Array	否	用户身份认证通过的凭证。
remainAttempts	number	否	剩余的认证尝试次数。
lockoutDuration	number	否	认证操作的锁定时长，时间单位为毫秒ms。

TipInfo⁹⁺

表示认证过程中的提示信息。

系统能力：以下各项对应的系统能力均为SystemCapability.UserIAM.UserAuth.Core。

名称	类型	必填	说明
module	number	是	发送提示信息的模块标识。
tip	number	是	认证过程提示信息。

EventInfo⁹⁺

表示认证过程中事件信息的类型。

系统能力：以下各项对应的系统能力均为SystemCapability.UserIAM.UserAuth.Core。

取值类型	说明
AuthResultInfo	获取到的认证结果信息。
TipInfo	认证过程中的提示信息。

AuthEventKey⁹⁺

表示认证事件类型的关键字，作为on接口的的参数。

系统能力：以下各项对应的系统能力均为SystemCapability.UserIAM.UserAuth.Core。

取值类型	说明
"result"	on接口第一个参数为"result"时，callback回调返回认证的结果信息。
"tip"	on接口第一个参数为"tip"时，callback回调返回认证操作中的提示信息。

AuthEvent⁹⁺

认证接口的异步回调对象。

callback⁹⁺

callback(result : EventInfo) : void

通过该回调获取认证结果信息或认证过程中的提示信息。

系统能力：SystemCapability.UserIAM.UserAuth.Core

参数：

参数名	类型	必填	说明
result	EventInfo	是	返回的认证结果信息或提示信息。

示例：

import userIAM_userAuth from '@ohos.userIAM.userAuth';

let challenge = new Uint8Array([1, 2, 3, 4, 5, 6, 7, 8]);
let authType = userIAM_userAuth.UserAuthType.FACE;
let authTrustLevel = userIAM_userAuth.AuthTrustLevel.ATL1;
// 通过callback获取认证结果
try {
  let auth = userIAM_userAuth.getAuthInstance(challenge, authType, authTrustLevel);
  auth.on('result', {
    callback: (result: userIAM_userAuth.AuthResultInfo) => {
      console.log('authV9 result ' + result.result);
      console.log('authV9 token ' + result.token);
      console.log('authV9 remainAttempts ' + result.remainAttempts);
      console.log('authV9 lockoutDuration ' + result.lockoutDuration);
    }
  } as userIAM_userAuth.AuthEvent);
  auth.start();
  console.log('authV9 start success');
} catch (error) {
  console.error('authV9 error = ' + error);
  // do error
}
// 通过callback获取认证过程中的提示信息
try {
  let auth = userIAM_userAuth.getAuthInstance(challenge, authType, authTrustLevel);
  auth.on('tip', {
    callback : (result : userIAM_userAuth.TipInfo) => {
      switch (result.tip) {
        case userIAM_userAuth.FaceTips.FACE_AUTH_TIP_TOO_BRIGHT:
          // do something;
        case userIAM_userAuth.FaceTips.FACE_AUTH_TIP_TOO_DARK:
          // do something;
        default:
          // do others
      }
    }
  } as userIAM_userAuth.AuthEvent);
  auth.start();
  console.log('authV9 start success');
} catch (error) {
  console.error('authV9 error = ' + error);
  // do error
}

AuthInstance^(deprecated)

执行用户认证的对象。

说明： 从 API version 9 开始支持，从 API version 10 开始废弃，请使用UserAuthInstance替代。

on^(deprecated)

on : (name : AuthEventKey, callback : AuthEvent) => void

订阅指定类型的用户认证事件。

说明： 从 API version 9 开始支持，从 API version 10 开始废弃。

说明： 使用获取到的AuthInstance对象调用该接口进行订阅。

系统能力：SystemCapability.UserIAM.UserAuth.Core

参数：

参数名	类型	必填	说明
name	AuthEventKey	是	表示认证事件类型，取值为"result"时，回调函数返回认证结果；取值为"tip"时，回调函数返回认证过程中的提示信息。
callback	AuthEvent	是	认证接口的回调函数，用于返回认证结果或认证过程中的提示信息。

错误码：

以下错误码的详细介绍请参见用户认证错误码。

错误码ID	错误信息
401	Incorrect parameters.
12500002	General operation error.

示例：

import userIAM_userAuth from '@ohos.userIAM.userAuth';

let challenge = new Uint8Array([1, 2, 3, 4, 5, 6, 7, 8]);
let authType = userIAM_userAuth.UserAuthType.FACE;
let authTrustLevel = userIAM_userAuth.AuthTrustLevel.ATL1;
try {
  let auth = userIAM_userAuth.getAuthInstance(challenge, authType, authTrustLevel);
  // 订阅认证结果
  auth.on('result', {
    callback: (result: userIAM_userAuth.AuthResultInfo) => {
      console.log('authV9 result ' + result.result);
      console.log('authV9 token ' + result.token);
      console.log('authV9 remainAttempts ' + result.remainAttempts);
      console.log('authV9 lockoutDuration ' + result.lockoutDuration);
    }
  });
  // 订阅认证过程中的提示信息
  auth.on('tip', {
    callback : (result : userIAM_userAuth.TipInfo) => {
      switch (result.tip) {
        case userIAM_userAuth.FaceTips.FACE_AUTH_TIP_TOO_BRIGHT:
          // do something;
        case userIAM_userAuth.FaceTips.FACE_AUTH_TIP_TOO_DARK:
          // do something;
        default:
          // do others
      }
    }
  } as userIAM_userAuth.AuthEvent);
  auth.start();
  console.log('authV9 start success');
} catch (error) {
  console.error('authV9 error = ' + error);
  // do error
}

off^(deprecated)

off : (name : AuthEventKey) => void

取消订阅特定类型的认证事件。

说明： 从 API version 9 开始支持，从 API version 10 开始废弃。

说明： 需要使用已经成功订阅事件的AuthInstance对象调用该接口进行取消订阅。

系统能力：SystemCapability.UserIAM.UserAuth.Core

名称	类型	必填	说明
name	AuthEventKey	是	表示认证事件类型，取值为"result"时，取消订阅认证结果；取值为"tip"时，取消订阅认证过程中的提示信息。

错误码：

以下错误码的详细介绍请参见用户认证错误码。

错误码ID	错误信息
401	Incorrect parameters.
12500002	General operation error.

示例：

import userIAM_userAuth from '@ohos.userIAM.userAuth';

let challenge = new Uint8Array([1, 2, 3, 4, 5, 6, 7, 8]);
let authType = userIAM_userAuth.UserAuthType.FACE;
let authTrustLevel = userIAM_userAuth.AuthTrustLevel.ATL1;
try {
  let auth = userIAM_userAuth.getAuthInstance(challenge, authType, authTrustLevel);
  // 订阅认证结果
  auth.on('result', {
    callback: (result: userIAM_userAuth.AuthResultInfo) => {
      console.log('authV9 result ' + result.result);
      console.log('authV9 token ' + result.token);
      console.log('authV9 remainAttempts ' + result.remainAttempts);
      console.log('authV9 lockoutDuration ' + result.lockoutDuration);
    }
  });
  // 取消订阅结果
  auth.off('result');
  console.info('cancel subscribe authentication event success');
} catch (error) {
  console.error('cancel subscribe authentication event failed, error =' + error);
  // do error
}

start^(deprecated)

start : () => void

开始认证。

说明： 从 API version 9 开始支持，从 API version 10 开始废弃。

说明： 使用获取到的AuthInstance对象调用该接口进行认证。

需要权限：ohos.permission.ACCESS_BIOMETRIC

系统能力：SystemCapability.UserIAM.UserAuth.Core

错误码：

以下错误码的详细介绍请参见用户认证错误码。

错误码ID	错误信息
201	Permission verification failed.
401	Incorrect parameters.
12500001	Authentication failed.
12500002	General operation error.
12500003	The operation is canceled.
12500004	The operation is time-out.
12500005	The authentication type is not supported.
12500006	The authentication trust level is not supported.
12500007	The authentication task is busy.
12500009	The authenticator is locked.
12500010	The type of credential has not been enrolled.

示例：

import userIAM_userAuth from '@ohos.userIAM.userAuth';

let challenge = new Uint8Array([1, 2, 3, 4, 5, 6, 7, 8]);
let authType = userIAM_userAuth.UserAuthType.FACE;
let authTrustLevel = userIAM_userAuth.AuthTrustLevel.ATL1;

try {
  let auth = userIAM_userAuth.getAuthInstance(challenge, authType, authTrustLevel);
  auth.start();
  console.info('authV9 start auth success');
} catch (error) {
  console.error('authV9 start auth failed, error = ' + error);
}

cancel^(deprecated)

cancel : () => void

取消认证。

说明： 从 API version 9 开始支持，从 API version 10 开始废弃。

说明： 使用获取到的AuthInstance对象调用该接口进行取消认证，此AuthInstance需要是正在进行认证的对象。

需要权限：ohos.permission.ACCESS_BIOMETRIC

系统能力：SystemCapability.UserIAM.UserAuth.Core

错误码：

以下错误码的详细介绍请参见用户认证错误码。

错误码ID	错误信息
201	Permission verification failed.
401	Incorrect parameters.
12500002	General operation error.

示例：

import userIAM_userAuth from '@ohos.userIAM.userAuth';

let challenge = new Uint8Array([1, 2, 3, 4, 5, 6, 7, 8]);
let authType = userIAM_userAuth.UserAuthType.FACE;
let authTrustLevel = userIAM_userAuth.AuthTrustLevel.ATL1;

try {
  let auth = userIAM_userAuth.getAuthInstance(challenge, authType, authTrustLevel);
  auth.cancel();
  console.info('cancel auth success');
} catch (error) {
  console.error('cancel auth failed, error = ' + error);
}

userIAM_userAuth.getAuthInstance^(deprecated)

getAuthInstance(challenge : Uint8Array, authType : UserAuthType, authTrustLevel : AuthTrustLevel): AuthInstance

获取AuthInstance对象，用于执行用户身份认证。

说明： 从 API version 9 开始支持，从 API version 10 开始废弃，请使用getUserAuthInstance替代。

说明： 每个AuthInstance只能进行一次认证，若需要再次进行认证则需重新获取AuthInstance。

系统能力：SystemCapability.UserIAM.UserAuth.Core

参数：

参数名	类型	必填	说明
challenge	Uint8Array	是	挑战值，最大长度为32字节，可以传Uint8Array([])。
authType	UserAuthType	是	认证类型，当前支持FACE。
authTrustLevel	AuthTrustLevel	是	认证信任等级。

返回值：

类型	说明
AuthInstance	认证器对象。

错误码：

以下错误码的详细介绍请参见用户认证错误码。

错误码ID	错误信息
401	Incorrect parameters.
12500002	General operation error.
12500005	The authentication type is not supported.
12500006	The authentication trust level is not supported.

示例：

import userIAM_userAuth from '@ohos.userIAM.userAuth';

let challenge = new Uint8Array([1, 2, 3, 4, 5, 6, 7, 8]);
let authType = userIAM_userAuth.UserAuthType.FACE;
let authTrustLevel = userIAM_userAuth.AuthTrustLevel.ATL1;

try {
  let auth = userIAM_userAuth.getAuthInstance(challenge, authType, authTrustLevel);
  console.info('let auth instance success');
} catch (error) {
  console.error('get auth instance success failed, error = ' + error);
}

userIAM_userAuth.getAvailableStatus⁹⁺

getAvailableStatus(authType : UserAuthType, authTrustLevel : AuthTrustLevel): void

查询指定类型和等级的认证能力是否支持。

需要权限：ohos.permission.ACCESS_BIOMETRIC

系统能力：SystemCapability.UserIAM.UserAuth.Core

参数：

参数名	类型	必填	说明
authType	UserAuthType	是	认证类型。
authTrustLevel	AuthTrustLevel	是	认证信任等级。

错误码：

以下错误码的详细介绍请参见用户认证错误码。

错误码ID	错误信息
201	Permission verification failed.
401	Incorrect parameters.
12500002	General operation error.
12500005	The authentication type is not supported.
12500006	The authentication trust level is not supported.
12500010	The type of credential has not been enrolled.

示例：

import userIAM_userAuth from '@ohos.userIAM.userAuth';

try {
  userIAM_userAuth.getAvailableStatus(userIAM_userAuth.UserAuthType.FACE, userIAM_userAuth.AuthTrustLevel.ATL1);
  console.info('current auth trust level is supported');
} catch (error) {
  console.error('current auth trust level is not supported, error = ' + error);
}

UserAuthResultCode⁹⁺

表示返回码的枚举。

系统能力：SystemCapability.UserIAM.UserAuth.Core

名称	值	说明
SUCCESS	12500000	执行成功。
FAIL	12500001	认证失败。
GENERAL_ERROR	12500002	操作通用错误。
CANCELED	12500003	操作取消。
TIMEOUT	12500004	操作超时。
TYPE_NOT_SUPPORT	12500005	不支持的认证类型。
TRUST_LEVEL_NOT_SUPPORT	12500006	不支持的认证等级。
BUSY	12500007	忙碌状态。
LOCKED	12500009	认证器已锁定。
NOT_ENROLLED	12500010	用户未录入认证信息。
CANCELED_FROM_WIDGET¹⁰⁺	12500011	当前的认证操作被用户从组件取消。返回这个错误码，表示使用应用自定义认证。

UserAuth^(deprecated)

认证器对象。

constructor^(deprecated)

constructor()

创建认证器对象。

说明： 从 API version 8 开始支持，从 API version 9 开始废弃，请使用getAuthInstance替代。

系统能力：SystemCapability.UserIAM.UserAuth.Core

返回值：

类型	说明
UserAuth	认证器对象。

示例：

import userIAM_userAuth from '@ohos.userIAM.userAuth';

let auth = new userIAM_userAuth.UserAuth();

getVersion^(deprecated)

getVersion() : number

获取认证器的版本信息。

说明： 从 API version 8 开始支持，从 API version 9 开始废弃。

需要权限：ohos.permission.ACCESS_BIOMETRIC

系统能力：SystemCapability.UserIAM.UserAuth.Core

返回值：

类型	说明
number	认证器版本信息。

示例：

import userIAM_userAuth from '@ohos.userIAM.userAuth';

let auth = new userIAM_userAuth.UserAuth();
let version = auth.getVersion();
console.info('auth version = ' + version);

getAvailableStatus^(deprecated)

getAvailableStatus(authType : UserAuthType, authTrustLevel : AuthTrustLevel) : number

查询指定类型和等级的认证能力是否支持。

说明： 从 API version 8 开始支持，从 API version 9 开始废弃，请使用getAvailableStatus替代。

需要权限：ohos.permission.ACCESS_BIOMETRIC

系统能力：SystemCapability.UserIAM.UserAuth.Core

参数：

参数名	类型	必填	说明
authType	UserAuthType	是	认证类型，当前只支持FACE。
authTrustLevel	AuthTrustLevel	是	认证信任等级。

返回值：

类型	说明
number	查询结果，结果为SUCCESS时表示支持，其他返回值参见ResultCode。

示例：

import userIAM_userAuth from '@ohos.userIAM.userAuth';

let auth = new userIAM_userAuth.UserAuth();
let checkCode = auth.getAvailableStatus(userIAM_userAuth.UserAuthType.FACE, userIAM_userAuth.AuthTrustLevel.ATL1);
if (checkCode == userIAM_userAuth.ResultCode.SUCCESS) {
  console.info('check auth support success');
} else {
  console.error('check auth support fail, code = ' + checkCode);
}

auth^(deprecated)

auth(challenge: Uint8Array, authType: UserAuthType, authTrustLevel: AuthTrustLevel, callback: IUserAuthCallback): Uint8Array

执行用户认证，使用回调函数返回结果。

说明： 从 API version 8 开始支持，从 API version 9 开始废弃，建议使用start代替。

需要权限：ohos.permission.ACCESS_BIOMETRIC

系统能力：SystemCapability.UserIAM.UserAuth.Core

参数：

参数名	类型	必填	说明
challenge	Uint8Array	是	挑战值，可以传Uint8Array([])。
authType	UserAuthType	是	认证类型，当前支持FACE。
authTrustLevel	AuthTrustLevel	是	认证信任等级。
callback	IUserAuthCallback	是	回调函数。

返回值：

类型	说明
Uint8Array	ContextId，作为取消认证cancelAuth接口的入参。

示例：

import userIAM_userAuth from '@ohos.userIAM.userAuth';

let auth = new userIAM_userAuth.UserAuth();
let challenge = new Uint8Array([]);
auth.auth(challenge, userIAM_userAuth.UserAuthType.FACE, userIAM_userAuth.AuthTrustLevel.ATL1, {
  onResult: (result, extraInfo) => {
    try {
      console.info('auth onResult result = ' + result);
      console.info('auth onResult extraInfo = ' + JSON.stringify(extraInfo));
      if (result == userIAM_userAuth.ResultCode.SUCCESS) {
        // 此处添加认证成功逻辑
      } else {
        // 此处添加认证失败逻辑
      }
    } catch (error) {
      console.error('auth onResult error = ' + error);
    }
  }
});

cancelAuth^(deprecated)

cancelAuth(contextID : Uint8Array) : number

表示通过contextID取消本次认证操作。

说明： 从 API version 8 开始支持，从 API version 9 开始废弃，建议使用cancel代替。

需要权限：ohos.permission.ACCESS_BIOMETRIC

系统能力：SystemCapability.UserIAM.UserAuth.Core

参数：

参数名	类型	必填	说明
contextID	Uint8Array	是	上下文的标识，通过auth接口获取。

返回值：

类型	说明
number	取消认证的结果，结果为SUCCESS时表示取消成功，其他返回值参见ResultCode。

示例：

import userIAM_userAuth from '@ohos.userIAM.userAuth';

// contextId可通过auth接口获取，此处直接定义
let contextId = new Uint8Array([0, 1, 2, 3, 4, 5, 6, 7]);
let auth = new userIAM_userAuth.UserAuth();
let cancelCode = auth.cancelAuth(contextId);
if (cancelCode == userIAM_userAuth.ResultCode.SUCCESS) {
  console.info('cancel auth success');
} else {
  console.error('cancel auth fail');
}

IUserAuthCallback^(deprecated)

返回认证结果的回调对象。

说明： 从 API version 8 开始支持，从 API version 9 开始废弃，建议使用AuthEvent代替。

onResult^(deprecated)

onResult: (result : number, extraInfo : AuthResult) => void

回调函数，返回认证结果。

说明： 从 API version 8 开始支持，从 API version 9 开始废弃，建议使用callback代替。

系统能力：SystemCapability.UserIAM.UserAuth.Core

参数：

参数名	类型	必填	说明
result	number	是	认证结果，参见ResultCode。
extraInfo	AuthResult	是	扩展信息，不同情况下的具体信息，如果身份验证通过，则在extraInfo中返回用户认证令牌，如果身份验证失败，则在extraInfo中返回剩余的用户认证次数，如果身份验证执行器被锁定，则在extraInfo中返回冻结时间。

示例：

import userIAM_userAuth from '@ohos.userIAM.userAuth';

let auth = new userIAM_userAuth.UserAuth();
let challenge = new Uint8Array([]);
auth.auth(challenge, userIAM_userAuth.UserAuthType.FACE, userIAM_userAuth.AuthTrustLevel.ATL1, {
  onResult: (result, extraInfo) => {
    try {
      console.info('auth onResult result = ' + result);
      console.info('auth onResult extraInfo = ' + JSON.stringify(extraInfo));
      if (result == userIAM_userAuth.ResultCode.SUCCESS) {
        // 此处添加认证成功逻辑
      }  else {
        // 此处添加认证失败逻辑
      }
    } catch (error) {
      console.error('auth onResult error = ' + error);
    }
  }
});

onAcquireInfo^(deprecated)

onAcquireInfo ?: (module : number, acquire : number, extraInfo : any) => void

回调函数，返回认证过程中的提示信息，非必须实现。

说明： 从 API version 8 开始支持，从 API version 9 开始废弃，建议使用callback代替。

系统能力：SystemCapability.UserIAM.UserAuth.Core

参数：

参数名	类型	必填	说明
module	number	是	发送提示信息的模块标识。
acquire	number	是	认证执过程中的提示信息。
extraInfo	any	是	预留字段。

示例：

import userIAM_userAuth from '@ohos.userIAM.userAuth';

let auth = new userIAM_userAuth.UserAuth();
let challenge = new Uint8Array([]);
auth.auth(challenge, userIAM_userAuth.UserAuthType.FACE, userIAM_userAuth.AuthTrustLevel.ATL1, {
  onResult: (result, extraInfo) => {
    try {
      console.info('auth onResult result = ' + result);
      console.info('auth onResult extraInfo = ' + JSON.stringify(extraInfo));
      if (result == userIAM_userAuth.ResultCode.SUCCESS) {
        // 此处添加认证成功逻辑
      }  else {
        // 此处添加认证失败逻辑
      }
    } catch (error) {
      console.error('auth onResult error = ' + error);
    }
  },
  onAcquireInfo: (module, acquire, extraInfo : userIAM_userAuth.AuthResult) => {
    try {
      console.info('auth onAcquireInfo module = ' + module);
      console.info('auth onAcquireInfo acquire = ' + acquire);
      console.info('auth onAcquireInfo extraInfo = ' + JSON.stringify(extraInfo));
    } catch (error) {
      console.error('auth onAcquireInfo error = ' + error);
    }
  }
});

AuthResult^(deprecated)

表示认证结果的对象。

说明： 从 API version 8 开始支持，从 API version 9 开始废弃，建议使用AuthResultInfo代替。

系统能力：SystemCapability.UserIAM.UserAuth.Core

名称	类型	必填	说明
token	Uint8Array	否	认证通过的令牌信息。
remainTimes	number	否	剩余的认证操作次数。
freezingTime	number	否	认证操作的冻结时间。

ResultCode^(deprecated)

表示返回码的枚举。

说明： 从 API version 9 开始废弃，建议使用UserAuthResultCode代替。

系统能力：SystemCapability.UserIAM.UserAuth.Core

名称	值	说明
SUCCESS	0	执行成功。
FAIL	1	认证失败。
GENERAL_ERROR	2	操作通用错误。
CANCELED	3	操作取消。
TIMEOUT	4	操作超时。
TYPE_NOT_SUPPORT	5	不支持的认证类型。
TRUST_LEVEL_NOT_SUPPORT	6	不支持的认证等级。
BUSY	7	忙碌状态。
INVALID_PARAMETERS	8	无效参数。
LOCKED	9	认证器已锁定。
NOT_ENROLLED	10	用户未录入认证信息。

FaceTips⁸⁺

表示人脸认证过程中提示码的枚举。

系统能力：SystemCapability.UserIAM.UserAuth.Core

名称	值	说明
FACE_AUTH_TIP_TOO_BRIGHT	1	光线太强，获取的图像太亮。
FACE_AUTH_TIP_TOO_DARK	2	光线太暗，获取的图像太暗。
FACE_AUTH_TIP_TOO_CLOSE	3	人脸距离设备过近。
FACE_AUTH_TIP_TOO_FAR	4	人脸距离设备过远。
FACE_AUTH_TIP_TOO_HIGH	5	设备太高，仅获取到人脸上部。
FACE_AUTH_TIP_TOO_LOW	6	设备太低，仅获取到人脸下部。
FACE_AUTH_TIP_TOO_RIGHT	7	设备太靠右，仅获取到人脸右部。
FACE_AUTH_TIP_TOO_LEFT	8	设备太靠左，仅获取到人脸左部。
FACE_AUTH_TIP_TOO_MUCH_MOTION	9	在图像采集过程中，用户人脸移动太快。
FACE_AUTH_TIP_POOR_GAZE	10	没有正视摄像头。
FACE_AUTH_TIP_NOT_DETECTED	11	没有检测到人脸信息。

FingerprintTips⁸⁺

表示指纹认证过程中提示码的枚举。

系统能力：SystemCapability.UserIAM.UserAuth.Core

名称	值	说明
FINGERPRINT_AUTH_TIP_GOOD	0	获取的指纹图像良好。
FINGERPRINT_AUTH_TIP_DIRTY	1	由于传感器上可疑或检测到的污垢，指纹图像噪音过大。
FINGERPRINT_AUTH_TIP_INSUFFICIENT	2	由于检测到的情况，指纹图像噪声太大，无法处理。
FINGERPRINT_AUTH_TIP_PARTIAL	3	仅检测到部分指纹图像。
FINGERPRINT_AUTH_TIP_TOO_FAST	4	快速移动，指纹图像不完整。
FINGERPRINT_AUTH_TIP_TOO_SLOW	5	缺少运动，指纹图像无法读取。

UserAuthType⁸⁺

表示身份认证的凭据类型枚举。

系统能力：SystemCapability.UserIAM.UserAuth.Core

名称	值	说明
PIN¹⁰⁺	1	口令认证。
FACE	2	人脸认证。
FINGERPRINT	4	指纹认证。

AuthTrustLevel⁸⁺

表示认证结果的信任等级枚举。

系统能力：SystemCapability.UserIAM.UserAuth.Core

名称	值	说明
ATL1	10000	认证结果的信任等级级别1，代表该认证方案能够识别用户个体，有一定的活体检测能力。常用的业务场景有业务风控、一般个人数据查询等。
ATL2	20000	认证结果的信任等级级别2，代表该认证方案能够精确识别用户个体，有一定的活体检测能力。常用的业务场景有维持设备解锁状态，应用登录等。
ATL3	30000	认证结果的信任等级级别3，代表该认证方案能够精确识别用户个体，有较强的活体检测能力。常用的业务场景有设备解锁等。
ATL4	40000	认证结果的信任等级级别4，代表该认证方案能够高精度的识别用户个体，有很强的活体检测能力。常用的业务场景有小额支付等。

userIAM_userAuth.getAuthenticator^(deprecated)

getAuthenticator(): Authenticator

获取Authenticator对象，用于执行用户身份认证。

说明： 从 API version 8 开始废弃，建议使用constructor替代。

系统能力：SystemCapability.UserIAM.UserAuth.Core

返回值：

类型	说明
Authenticator	认证器对象。

示例：

import userIAM_userAuth from '@ohos.userIAM.userAuth';

let authenticator = userIAM_userAuth.getAuthenticator();

Authenticator^(deprecated)

认证器对象。

说明： 从 API version 8 开始废弃，建议使用UserAuth替代。

execute^(deprecated)

execute(type: AuthType, level: SecureLevel, callback: AsyncCallback<number>): void

执行用户认证，使用callback方式作为异步方法。

说明： 从 API version 8 开始废弃，建议使用auth替代。

需要权限：ohos.permission.ACCESS_BIOMETRIC

系统能力：SystemCapability.UserIAM.UserAuth.Core

参数：

参数名	类型	必填	说明
type	AuthType	是	认证类型，当前只支持"FACE_ONLY"。 ALL为预留参数，当前版本暂不支持ALL类型的认证。
level	SecureLevel	是	安全级别，对应认证的安全级别，有效值为"S1"（最低）、"S2"、"S3"、"S4"（最高）。具备3D人脸识别能力的设备支持"S3"及以下安全级别的认证。具备2D人脸识别能力的设备支持"S2"及以下安全级别的认证。
callback	AsyncCallback<number>	是	回调函数。

callback返回值：

类型	说明
number	表示认证结果，参见AuthenticationResult。

示例：

import userIAM_userAuth from '@ohos.userIAM.userAuth';

let authenticator = userIAM_userAuth.getAuthenticator();
authenticator.execute('FACE_ONLY', 'S2', (error, code)=>{
  if (code === userIAM_userAuth.ResultCode.SUCCESS) {
    console.info('auth success');
    return;
  }
  console.error('auth fail, code = ' + code);
});

execute^(deprecated)

execute(type : AuthType, level : SecureLevel): Promise<number>

执行用户认证，使用promise方式作为异步方法。

说明： 从 API version 8 开始废弃，建议使用auth替代。

需要权限：ohos.permission.ACCESS_BIOMETRIC

系统能力：SystemCapability.UserIAM.UserAuth.Core

参数：

参数名	类型	必填	说明
type	AuthType	是	认证类型，当前只支持"FACE_ONLY"。 ALL为预留参数，当前版本暂不支持ALL类型的认证。
level	SecureLevel	是	安全级别，对应认证的安全级别，有效值为"S1"（最低）、"S2"、"S3"、"S4"（最高）。具备3D人脸识别能力的设备支持"S3"及以下安全级别的认证。具备2D人脸识别能力的设备支持"S2"及以下安全级别的认证。

返回值：

类型	说明
Promise<number>	返回携带一个number的Promise。number 为认证结果，参见AuthenticationResult。

示例：

import userIAM_userAuth from '@ohos.userIAM.userAuth';

try {
  let authenticator = userIAM_userAuth.getAuthenticator();
  authenticator.execute('FACE_ONLY', 'S2').then((code)=>{
    console.info('auth success');
  })
} catch (error) {
  console.error('auth fail, code = ' + error);
}

AuthenticationResult^(deprecated)

表示认证结果的枚举。

说明： 从 API version 8 开始废弃，建议使用ResultCode替代。

系统能力：SystemCapability.UserIAM.UserAuth.Core

名称	值	说明
NO_SUPPORT	-1	设备不支持当前的认证方式。
SUCCESS	0	认证成功。
COMPARE_FAILURE	1	比对失败。
CANCELED	2	用户取消认证。
TIMEOUT	3	认证超时。
CAMERA_FAIL	4	开启相机失败。
BUSY	5	认证服务忙，请稍后重试。
INVALID_PARAMETERS	6	认证参数无效。
LOCKED	7	认证失败次数过多，已锁定。
NOT_ENROLLED	8	未录入认证凭据。
GENERAL_ERROR	100	其他错误。

@ohos.userIAM.userAuth (用户认证)

导入模块

WindowModeType10+

AuthParam10+

WidgetParam10+

UserAuthResult10+

IAuthCallback10+

onResult10+

UserAuthInstance10+

on10+

off10+

start10+

cancel10+

getUserAuthInstance10+

NoticeType10+

sendNotice10+

UserAuthWidgetMgr10+

on10+

off10+

getUserAuthWidgetMgr10+

IAuthWidgetCallback10+

sendCommand10+

AuthResultInfo9+

TipInfo9+

EventInfo9+

AuthEventKey9+

AuthEvent9+

callback9+

AuthInstance(deprecated)

on(deprecated)

off(deprecated)

start(deprecated)

cancel(deprecated)

userIAM_userAuth.getAuthInstance(deprecated)

userIAM_userAuth.getAvailableStatus9+

UserAuthResultCode9+

UserAuth(deprecated)

constructor(deprecated)

getVersion(deprecated)

getAvailableStatus(deprecated)

auth(deprecated)

cancelAuth(deprecated)

IUserAuthCallback(deprecated)

onResult(deprecated)

onAcquireInfo(deprecated)

AuthResult(deprecated)

ResultCode(deprecated)

FaceTips8+

FingerprintTips8+

UserAuthType8+

AuthTrustLevel8+

userIAM_userAuth.getAuthenticator(deprecated)

Authenticator(deprecated)

execute(deprecated)

execute(deprecated)

AuthenticationResult(deprecated)

WindowModeType¹⁰⁺

AuthParam¹⁰⁺

WidgetParam¹⁰⁺

UserAuthResult¹⁰⁺

IAuthCallback¹⁰⁺

onResult¹⁰⁺

UserAuthInstance¹⁰⁺

on¹⁰⁺

off¹⁰⁺

start¹⁰⁺

cancel¹⁰⁺

getUserAuthInstance¹⁰⁺

NoticeType¹⁰⁺

sendNotice¹⁰⁺

UserAuthWidgetMgr¹⁰⁺

on¹⁰⁺

off¹⁰⁺

getUserAuthWidgetMgr¹⁰⁺

IAuthWidgetCallback¹⁰⁺

sendCommand¹⁰⁺

AuthResultInfo⁹⁺

TipInfo⁹⁺

EventInfo⁹⁺

AuthEventKey⁹⁺

AuthEvent⁹⁺

callback⁹⁺

AuthInstance^(deprecated)

on^(deprecated)

off^(deprecated)

start^(deprecated)

cancel^(deprecated)

userIAM_userAuth.getAuthInstance^(deprecated)

userIAM_userAuth.getAvailableStatus⁹⁺

UserAuthResultCode⁹⁺

UserAuth^(deprecated)

constructor^(deprecated)

getVersion^(deprecated)

getAvailableStatus^(deprecated)

auth^(deprecated)

cancelAuth^(deprecated)

IUserAuthCallback^(deprecated)

onResult^(deprecated)

onAcquireInfo^(deprecated)

AuthResult^(deprecated)

ResultCode^(deprecated)

FaceTips⁸⁺

FingerprintTips⁸⁺

UserAuthType⁸⁺

AuthTrustLevel⁸⁺

userIAM_userAuth.getAuthenticator^(deprecated)

Authenticator^(deprecated)

execute^(deprecated)

execute^(deprecated)

AuthenticationResult^(deprecated)