harmony 鸿蒙@ohos.userIAM.userAuth (User Authentication)
@ohos.userIAM.userAuth (User Authentication)
The userIAM.userAuth module provides user authentication capabilities in identity authentication scenarios, such as device unlocking, payment, and app login.
NOTE
The initial APIs of this module are supported since API version 6. Newly added APIs will be marked with a superscript to indicate their earliest API version.
Modules to Import
import userIAM_userAuth from '@ohos.userIAM.userAuth';
WindowModeType10+
Enumerates the window types of the authentication widget.
System capability: SystemCapability.UserIAM.UserAuth.Core
System API: This is a system API.
Name | Value | Description |
---|---|---|
DIALOG_BOX | 1 | Dialog box. |
FULLSCREEN | 2 | Full screen. |
AuthParam10+
Defines the user authentication parameters.
System capability: SystemCapability.UserIAM.UserAuth.Core
Name | Type | Mandatory | Description |
---|---|---|---|
challenge | Uint8Array | Yes | Challenge value, which is used to prevent replay attacks. It cannot exceed 32 bytes and can be passed in Uint8Array([]) format. |
authType | UserAuthType[] | Yes | Authentication type list, which specifies the types of authentication provided on the user authentication page. |
authTrustLevel | AuthTrustLevel | Yes | Authentication trust level. |
WidgetParam10+
Represents the information presented on the user authentication page.
System capability: SystemCapability.UserIAM.UserAuth.Core
Name | Type | Mandatory | Description |
---|---|---|---|
title | string | Yes | Title of the user authentication page. It cannot exceed 500 characters. |
navigationButtonText | string | No | Text on the navigation button. It cannot exceed 60 characters. This parameter is valid only in fingerprint or facial authentication only. |
windowMode | WindowModeType | No | Display format of the user authentication page. The default value is WindowModeType.DIALOG_BOX. System API: This is a system API. |
UserAuthResult10+
Defines the user authentication result. If the authentication is successful, the authentication type and information about the token that has passed the authentication are returned.
System capability: SystemCapability.UserIAM.UserAuth.Core
Name | Type | Mandatory | Description |
---|---|---|---|
result | number | Yes | User authentication result. If the operation is successful, 0 is returned. If the operation fails, an error code is returned. For details about the error codes, see User Authentication Error Codes. |
token | Uint8Array | No | Token that has passed the authentication. |
authType | UserAuthType | No | Type of the authentication. |
IAuthCallback10+
Provides callbacks to return the authentication result.
onResult10+
onResult(result: UserAuthResult): void
Called to return the authentication result.
System capability: SystemCapability.UserIAM.UserAuth.Core
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
result | UserAuthResult | Yes | Authentication result. |
Example
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:'Enter password',
};
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.log('auth catch error: ' + JSON.stringify(error));
}
UserAuthInstance10+
Provides APIs for user authentication. The user authentication widget is supported. Before using the APIs, you need to obtain a UserAuthInstance instance by using getUserAuthInstance.
on10+
on(type: ‘result’, callback: IAuthCallback): void
Subscribes to the user authentication result.
System capability: SystemCapability.UserIAM.UserAuth.Core
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
type | ‘result’ | Yes | Event type. The value is result, which indicates the authentication result. |
callback | IAuthCallback | Yes | Callback invoked to return the user authentication result. |
Error codes
For details about the error codes, see User Authentication Error Codes.
ID | Error Message |
---|---|
401 | Incorrect parameters. |
12500002 | General operation error. |
Example
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:'Enter password',
};
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.log('auth catch error: ' + JSON.stringify(error));
}
off10+
off(type: ‘result’, callback?: IAuthCallback): void
Unsubscribes from the user authentication result.
NOTE
You need to use the UserAuthInstance instance that has successfully subscribed to the event to call this API.
System capability: SystemCapability.UserIAM.UserAuth.Core
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
type | ‘result’ | Yes | Event type. The value is result, which indicates the authentication result. |
callback | IAuthCallback | No | Callback for the user authentication result. |
Error codes
For details about the error codes, see User Authentication Error Codes.
ID | Error Message |
---|---|
401 | Incorrect parameters. |
12500002 | General operation error. |
Example
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:'Enter password',
};
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.log('auth catch error: ' + JSON.stringify(error));
}
start10+
start(): void
Starts authentication.
Required permissions: ohos.permission.ACCESS_BIOMETRIC
System capability: SystemCapability.UserIAM.UserAuth.Core
Error codes
For details about the error codes, see User Authentication Error Codes.
ID | Error Message |
---|---|
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. |
Example
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:'Enter password',
};
try {
let userAuthInstance = userAuth.getUserAuthInstance(authParam, widgetParam);
console.log('get userAuth instance success');
userAuthInstance.start();
console.log('auth start success');
} catch (error) {
console.log('auth catch error: ' + JSON.stringify(error));
}
cancel10+
cancel(): void
Cancels this authentication.
NOTE
UserAuthInstance must be the instance being authenticated.
Required permissions: ohos.permission.ACCESS_BIOMETRIC
System capability: SystemCapability.UserIAM.UserAuth.Core
Error codes
ID | Error Message |
---|---|
201 | Permission verification failed. |
401 | Incorrect parameters. |
12500002 | General operation error. |
Example
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:'Enter password',
};
try {
let userAuthInstance = userAuth.getUserAuthInstance(authParam, widgetParam);
console.log('get userAuth instance success');
userAuthInstance.cancel();
console.log('auth cancel success');
} catch (error) {
console.log('auth catch error: ' + JSON.stringify(error));
}
getUserAuthInstance10+
getUserAuthInstance(authParam: AuthParam, widgetParam: WidgetParam): UserAuthInstance
Obtains a UserAuthInstance instance for user authentication. The user authentication widget is supported.
NOTE
A UserAuthInstance instance can be used for an authentication only once.
System capability: SystemCapability.UserIAM.UserAuth.Core
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
authParam | AuthParam | Yes | User authentication parameters. |
widgetParam | WidgetParam | Yes | Parameters on the user authentication page. |
Return value
Type | Description |
---|---|
UserAuthInstance | UserAuthInstance instance that supports UI. |
Error codes
For details about the error codes, see User Authentication Error Codes.
ID | Error Message |
---|---|
401 | Incorrect parameters. |
12500002 | General operation error. |
12500005 | The authentication type is not supported. |
12500006 | The authentication trust level is not supported. |
Example
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:'Enter password',
};
try {
let userAuthInstance = userAuth.getUserAuthInstance(authParam, widgetParam);
console.log('get userAuth instance success');
} catch (error) {
console.log('auth catch error: ' + JSON.stringify(error));
}
NoticeType10+
Defines the type of the user authentication notification.
System capability: SystemCapability.UserIAM.UserAuth.Core
System API: This is a system API.
Name | Value | Description |
---|---|---|
WIDGET_NOTICE | 1 | Notification from the user authentication widget. |
sendNotice10+
sendNotice(noticeType: NoticeType, eventData: string): void
Sends a notification from the user authentication widget.
Required permissions: ohos.permission.SUPPORT_USER_AUTH
System capability: SystemCapability.UserIAM.UserAuth.Core
System API: This is a system API.
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
noticeType | NoticeType | Yes | Notification type. |
eventData | string | Yes | Event data. |
Error codes
For details about the error codes, see User Authentication Error Codes.
ID | Error Message |
---|---|
201 | Permission verification failed. |
202 | The caller is not a system application. |
401 | Incorrect parameters. |
12500002 | General operation error. |
Example
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.log('sendNotice catch error: ' + JSON.stringify(error));
}
UserAuthWidgetMgr10+
Provides APIs for managing the user authentication widget. You can use the APIs to register the user authentication widget with UserAuthWidgetMgr for management and scheduling.
on10+
on(type: ‘command’, callback: IAuthWidgetCallback): void
Subscribes to commands from the user authentication framework.
System capability: SystemCapability.UserIAM.UserAuth.Core
System API: This is a system API.
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
type | ‘command’ | Yes | Event type. The vlaue is command, which indicates the command sent from the user authentication framework to the user authentication widget. |
callback | IAuthWidgetCallback | Yes | Callback invoked to send the command from the user authentication framework to the user authentication widget. |
Error codes
For details about the error codes, see User Authentication Error Codes.
ID | Error Message |
---|---|
401 | Incorrect parameters. |
12500002 | General operation error. |
Example
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.log('userAuth widgetMgr catch error: ' + JSON.stringify(error));
}
off10+
off(type: ‘command’, callback?: IAuthWidgetCallback): void
Unsubscribes from commands sent from the user authentication framework.
System capability: SystemCapability.UserIAM.UserAuth.Core
System API: This is a system API.
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
type | ‘command’ | Yes | Event type. The value is command, which indicates the command sent from the user authentication framework to the user authentication widget. |
callback | IAuthWidgetCallback | No | Callback for the command sent from the user authentication framework to the user authentication widget. |
Error codes
For details about the error codes, see User Authentication Error Codes.
ID | Error Message |
---|---|
401 | Incorrect parameters. |
12500002 | General operation error. |
Example
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.log('userAuth widgetMgr catch error: ' + JSON.stringify(error));
}
getUserAuthWidgetMgr10+
getUserAuthWidgetMgr(version: number): UserAuthWidgetMgr
Obtains a UserAuthWidgetMgr instance for user authentication.
NOTE
A UserAuthInstance instance can be used for an authentication only once.
Required permissions: ohos.permission.SUPPORT_USER_AUTH
System capability: SystemCapability.UserIAM.UserAuth.Core
System API: This is a system API.
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
version | number | Yes | Version of the user authentication widget. |
Return value
Type | Description |
---|---|
UserAuthWidgetMgr | UserAuthWidgetMgr instance obtained. |
Error codes
For details about the error codes, see User Authentication Error Codes.
ID | Error Message |
---|---|
201 | Permission verification failed. |
202 | The caller is not a system application. |
401 | Incorrect parameters. |
12500002 | General operation error. |
Example
import userAuth from '@ohos.userIAM.userAuth';
let userAuthWidgetMgrVersion = 1;
try {
let userAuthWidgetMgr = userAuth.getUserAuthWidgetMgr(userAuthWidgetMgrVersion);
console.log('get userAuthWidgetMgr instance success');
} catch (error) {
console.log('userAuth widgetMgr catch error: ' + JSON.stringify(error));
}
IAuthWidgetCallback10+
Provides the callback for returning the commands sent from the user authentication framework to the user authentication widget.
sendCommand10+
sendCommand(cmdData: string): void
Called to return the command sent from the user authentication framework to the user authentication widget.
System capability: SystemCapability.UserIAM.UserAuth.Core
System API: This is a system API.
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
cmdData | string | Yes | Command sent from the user identity authentication framework to the user authentication widget. |
Example
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.log('userAuth widgetMgr catch error: ' + JSON.stringify(error));
}
AuthResultInfo9+
Defines the authentication result.
System capability: SystemCapability.UserIAM.UserAuth.Core
Name | Type | Mandatory | Description |
---|---|---|---|
result | number | Yes | Authentication result. |
token | Uint8Array | No | Token that has passed the user identity authentication. |
remainAttempts | number | No | Number of remaining authentication attempts. |
lockoutDuration | number | No | Lock duration of the authentication operation, in milliseconds. |
TipInfo9+
Defines the authentication tip information.
System capability: SystemCapability.UserIAM.UserAuth.Core
Name | Type | Mandatory | Description |
---|---|---|---|
module | number | Yes | ID of the module that sends the tip information. |
tip | number | Yes | Tip to be given during the authentication process. |
EventInfo9+
Enumerates the authentication event information types.
System capability: SystemCapability.UserIAM.UserAuth.Core
Value | Description |
---|---|
AuthResultInfo | Authentication result. |
TipInfo | Authentication tip information. |
AuthEventKey9+
Defines the keyword of the authentication event type. It is used as a parameter of on.
System capability: SystemCapability.UserIAM.UserAuth.Core
Value | Description |
---|---|
“result” | If the first parameter of on is result, the callback returns the authentication result. |
“tip” | If the first parameter of on is tip, the callback returns the authentication tip information. |
AuthEvent9+
Provides an asynchronous callback to return the authentication event information.
callback9+
callback(result : EventInfo) : void
Called to return the authentication result or authentication tip information.
System capability: SystemCapability.UserIAM.UserAuth.Core
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
result | EventInfo | Yes | Authentication result or tip information. |
Example
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;
// Obtain the authentication result through a 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.log('authV9 error = ' + error);
// do error
}
// Obtain the authentication tip information through a 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.log('authV9 error = ' + error);
// do error
}
AuthInstance(deprecated)
Implements user authentication.
NOTE
This API is supported since API version 9 and deprecated since API version 10. Use UserAuthInstance instead.
on(deprecated)
on : (name : AuthEventKey, callback : AuthEvent) => void
Subscribes to the user authentication events of the specified type.
NOTE
This API is supported since API version 9 and deprecated since API version 10.NOTE
Use the AuthInstance instance obtained to invoke this API to subscribe to events.
System capability: SystemCapability.UserIAM.UserAuth.Core
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
name | AuthEventKey | Yes | Authentication event type. If the value is result, the callback returns the authentication result. If the value is tip, the callback returns the authentication tip information. |
callback | AuthEvent | Yes | Callback invoked to return the authentication result or tip information. |
Error codes
For details about the error codes, see User Authentication Error Codes.
ID | Error Message |
---|---|
401 | Incorrect parameters. |
12500002 | General operation error. |
Example
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);
// Subscribe to the authentication result.
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);
}
});
// Subscribe to authentication tip information.
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.log('authV9 error = ' + error);
// do error
}
off(deprecated)
off : (name : AuthEventKey) => void
Unsubscribes from the user authentication events of the specific type.
NOTE
This API is supported since API version 9 and deprecated since API version 10.Use the AuthInstance instance obtained to invoke this API to unsubscribe from events.
System capability: SystemCapability.UserIAM.UserAuth.Core
Name | Type | Mandatory | Description |
---|---|---|---|
name | AuthEventKey | Yes | Type of the authentication event to unsubscribe from. If the value is result, the authentication result is unsubscribed from. If the value is tip, the authentication tip information is unsubscribed from. |
Error codes
For details about the error codes, see User Authentication Error Codes.
ID | Error Message |
---|---|
401 | Incorrect parameters. |
12500002 | General operation error. |
Example
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);
// Subscribe to the authentication result.
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);
}
});
// Unsubscription result.
auth.off('result');
console.info('cancel subscribe authentication event success');
} catch (error) {
console.info('cancel subscribe authentication event failed, error =' + error);
// do error
}
start(deprecated)
start : () => void
Starts authentication.
NOTE
This API is supported since API version 9 and deprecated since API version 10.Use the AuthInstance instance obtained to invoke this API.
Required permissions: ohos.permission.ACCESS_BIOMETRIC
System capability: SystemCapability.UserIAM.UserAuth.Core
Error codes
For details about the error codes, see User Authentication Error Codes.
ID | Error Message |
---|---|
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. |
Example
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.info('authV9 start auth failed, error = ' + error);
}
cancel(deprecated)
cancel : () => void
Cancels this authentication.
NOTE
This API is supported since API version 9 and deprecated since API version 10.Use the AuthInstance instance obtained to invoke this API. The AuthInstance instance must be the instance being authenticated.
Required permissions: ohos.permission.ACCESS_BIOMETRIC
System capability: SystemCapability.UserIAM.UserAuth.Core
Error codes
For details about the error codes, see User Authentication Error Codes.
ID | Error Message |
---|---|
201 | Permission verification failed. |
401 | Incorrect parameters. |
12500002 | General operation error. |
Example
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.info('cancel auth failed, error = ' + error);
}
userIAM_userAuth.getAuthInstance(deprecated)
getAuthInstance(challenge : Uint8Array, authType : UserAuthType, authTrustLevel : AuthTrustLevel): AuthInstance
Obtains an AuthInstance instance for user authentication.
NOTE
This API is supported since API version 9 and deprecated since API version 10. Use getUserAuthInstance instead.An AuthInstance instance can be used for an authentication only once.
System capability: SystemCapability.UserIAM.UserAuth.Core
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
challenge | Uint8Array | Yes | Challenge value. It cannot exceed 32 bytes and can be passed in Uint8Array([]) format. |
authType | UserAuthType | Yes | Authentication type. Only FACE is supported. |
authTrustLevel | AuthTrustLevel | Yes | Authentication trust level. |
Return value
Type | Description |
---|---|
AuthInstance | AuthInstance instance obtained. |
Error codes
For details about the error codes, see User Authentication Error Codes.
ID | Error Message |
---|---|
401 | Incorrect parameters. |
12500002 | General operation error. |
12500005 | The authentication type is not supported. |
12500006 | The authentication trust level is not supported. |
Example
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.info('get auth instance success failed, error = ' + error);
}
userIAM_userAuth.getAvailableStatus9+
getAvailableStatus(authType : UserAuthType, authTrustLevel : AuthTrustLevel): void
Checks whether the specified authentication capability is supported.
Required permissions: ohos.permission.ACCESS_BIOMETRIC
System capability: SystemCapability.UserIAM.UserAuth.Core
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
authType | UserAuthType | Yes | Authentication type. |
authTrustLevel | AuthTrustLevel | Yes | Authentication trust level. |
Error codes
For details about the error codes, see User Authentication Error Codes.
ID | Error Message |
---|---|
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. |
Example
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.info('current auth trust level is not supported, error = ' + error);
}
UserAuthResultCode9+
Enumerates the authentication result codes.
System capability: SystemCapability.UserIAM.UserAuth.Core
Name | Value | Description |
---|---|---|
SUCCESS | 12500000 | The authentication is successful. |
FAIL | 12500001 | The authentication failed. |
GENERAL_ERROR | 12500002 | A general operation error occurred. |
CANCELED | 12500003 | The authentication is canceled. |
TIMEOUT | 12500004 | The authentication timed out. |
TYPE_NOT_SUPPORT | 12500005 | The authentication type is not supported. |
TRUST_LEVEL_NOT_SUPPORT | 12500006 | The authentication trust level is not supported. |
BUSY | 12500007 | Indicates the busy state. |
LOCKED | 12500009 | The authentication executor is locked. |
NOT_ENROLLED | 12500010 | The user has not entered the authentication information. |
CANCELED_FROM_WIDGET10+ | 12500011 | The authentication is canceled by the user from the user authentication widget. If this error code is returned, the authentication is customized by the application. |
UserAuth(deprecated)
Provides APIs for user authentication.
constructor(deprecated)
constructor()
A constructor used to create a UserAuth instance.
NOTE
This API is supported since API version 8 and deprecated since API version 9. Use getAuthInstance instead.
System capability: SystemCapability.UserIAM.UserAuth.Core
Return value
Type | Description |
---|---|
UserAuth | UserAuth instance created. |
Example
import userIAM_userAuth from '@ohos.userIAM.userAuth';
let auth = new userIAM_userAuth.UserAuth();
getVersion(deprecated)
getVersion() : number
Obtains the version of this authenticator.
NOTE
This API is supported since API version 8 and deprecated since API version 9.
Required permissions: ohos.permission.ACCESS_BIOMETRIC
System capability: SystemCapability.UserIAM.UserAuth.Core
Return value
Type | Description |
---|---|
number | Authenticator version obtained. |
Example
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
Checks whether the specified authentication capability is supported.
NOTE
This API is supported since API version 8 and deprecated since API version 9. You are advised to use getAvailableStatus.
Required permissions: ohos.permission.ACCESS_BIOMETRIC
System capability: SystemCapability.UserIAM.UserAuth.Core
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
authType | UserAuthType | Yes | Authentication type. Only FACE is supported. |
authTrustLevel | AuthTrustLevel | Yes | Authentication trust level. |
Return value
Type | Description |
---|---|
number | Query result. If the authentication capability is supported, SUCCESS is returned. Otherwise, a ResultCode is returned. |
Example
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
Performs user authentication. This API uses a callback to return the result.
NOTE
This API is supported since API version 8 and deprecated since API version 9. Use start instead.
Required permissions: ohos.permission.ACCESS_BIOMETRIC
System capability: SystemCapability.UserIAM.UserAuth.Core
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
challenge | Uint8Array | Yes | Challenge value, which can be passed in Uint8Array([]) format. |
authType | UserAuthType | Yes | Authentication type. Only FACE is supported. |
authTrustLevel | AuthTrustLevel | Yes | Authentication trust level. |
callback | IUserAuthCallback | Yes | Callback used to return the result. |
Return value
Type | Description |
---|---|
Uint8Array | Context ID, which is used as the input parameter of cancelAuth. |
Example
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) {
// Add the logic to be executed when the authentication is successful.
} else {
// Add the logic to be executed when the authentication fails.
}
} catch (e) {
console.info('auth onResult error = ' + e);
}
}
});
cancelAuth(deprecated)
cancelAuth(contextID : Uint8Array) : number
Cancels an authentication based on the context ID.
NOTE
This API is supported since API version 8 and deprecated since API version 9. Use cancel instead.
Required permissions: ohos.permission.ACCESS_BIOMETRIC
System capability: SystemCapability.UserIAM.UserAuth.Core
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
contextID | Uint8Array | Yes | Context ID, which is obtained by auth. |
Return value
Type | Description |
---|---|
number | Returns SUCCESS if the cancellation is successful. Returns a ResultCode otherwise. |
Example
import userIAM_userAuth from '@ohos.userIAM.userAuth';
// contextId can be obtained by auth(). In this example, it is defined here.
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)
Provides callbacks to return the authentication result.
NOTE
This object is supported since API version 8 and deprecated since API version 9. You are advised to use AuthEvent.
onResult(deprecated)
onResult: (result : number, extraInfo : AuthResult) => void
Called to return the authentication result.
NOTE
This API is supported since API version 8 and deprecated since API version 9. You are advised to use callback.
System capability: SystemCapability.UserIAM.UserAuth.Core
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
result | number | Yes | Authentication result. For details, see ResultCode. |
extraInfo | AuthResult | Yes | Extended information, which varies depending on the authentication result. If the authentication is successful, the user authentication token will be returned in extraInfo. If the authentication fails, the remaining number of authentication times will be returned in extraInfo. If the authentication executor is locked, the freeze time will be returned in extraInfo. |
Example
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) {
// Add the logic to be executed when the authentication is successful.
} else {
// Add the logic to be executed when the authentication fails.
}
} catch (e) {
console.info('auth onResult error = ' + e);
}
}
});
onAcquireInfo(deprecated)
onAcquireInfo ?: (module : number, acquire : number, extraInfo : any) => void
Called to acquire authentication tip information. This API is optional.
NOTE
This API is supported since API version 8 and deprecated since API version 9. You are advised to use callback.
System capability: SystemCapability.UserIAM.UserAuth.Core
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
module | number | Yes | ID of the module that sends the tip information. |
acquire | number | Yes | Authentication tip information. |
extraInfo | any | Yes | Reserved field. |
Example
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) {
// Add the logic to be executed when the authentication is successful.
} else {
// Add the logic to be executed when the authentication fails.
}
} catch (e) {
console.info('auth onResult error = ' + e);
}
},
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 (e) {
console.info('auth onAcquireInfo error = ' + e);
}
}
});
AuthResult(deprecated)
Represents the authentication result object.
NOTE
This object is supported since API version 8 and deprecated since API version 9. You are advised to use AuthResultInfo.
System capability: SystemCapability.UserIAM.UserAuth.Core
Name | Type | Mandatory | Description |
---|---|---|---|
token | Uint8Array | No | Authentication token information. |
remainTimes | number | No | Number of remaining authentication operations. |
freezingTime | number | No | Time for which the authentication operation is frozen. |
ResultCode(deprecated)
Enumerates the authentication result codes.
NOTE
This object is deprecated since API version 9. You are advised to use UserAuthResultCode.
System capability: SystemCapability.UserIAM.UserAuth.Core
Name | Value | Description |
---|---|---|
SUCCESS | 0 | The operation is successful. |
FAIL | 1 | The authentication failed. |
GENERAL_ERROR | 2 | A general operation error occurred. |
CANCELED | 3 | The authentication is canceled. |
TIMEOUT | 4 | The authentication timed out. |
TYPE_NOT_SUPPORT | 5 | The authentication type is not supported. |
TRUST_LEVEL_NOT_SUPPORT | 6 | The authentication trust level is not supported. |
BUSY | 7 | Indicates the busy state. |
INVALID_PARAMETERS | 8 | Invalid parameters are detected. |
LOCKED | 9 | The authentication executor is locked. |
NOT_ENROLLED | 10 | The user has not entered the authentication information. |
FaceTips8+
Enumerates the tip codes used during the facial authentication process.
System capability: SystemCapability.UserIAM.UserAuth.Core
Name | Value | Description |
---|---|---|
FACE_AUTH_TIP_TOO_BRIGHT | 1 | The obtained facial image is too bright due to high illumination. |
FACE_AUTH_TIP_TOO_DARK | 2 | The obtained facial image is too dark due to low illumination. |
FACE_AUTH_TIP_TOO_CLOSE | 3 | The face is too close to the device. |
FACE_AUTH_TIP_TOO_FAR | 4 | The face is too far away from the device. |
FACE_AUTH_TIP_TOO_HIGH | 5 | Only the upper part of the face is captured because the device is angled too high. |
FACE_AUTH_TIP_TOO_LOW | 6 | Only the lower part of the face is captured because the device is angled too low. |
FACE_AUTH_TIP_TOO_RIGHT | 7 | Only the right part of the face is captured because the device is deviated to the right. |
FACE_AUTH_TIP_TOO_LEFT | 8 | Only the left part of the face is captured because the device is deviated to the left. |
FACE_AUTH_TIP_TOO_MUCH_MOTION | 9 | The face moves too fast during facial information collection. |
FACE_AUTH_TIP_POOR_GAZE | 10 | The face is not facing the camera. |
FACE_AUTH_TIP_NOT_DETECTED | 11 | No face is detected. |
FingerprintTips8+
Enumerates the tip codes used during the fingerprint authentication process.
System capability: SystemCapability.UserIAM.UserAuth.Core
Name | Value | Description |
---|---|---|
FINGERPRINT_AUTH_TIP_GOOD | 0 | The obtained fingerprint image is in good condition. |
FINGERPRINT_AUTH_TIP_DIRTY | 1 | Large fingerprint image noise is detected due to suspicious or detected dirt on the sensor. |
FINGERPRINT_AUTH_TIP_INSUFFICIENT | 2 | The noise of the fingerprint image is too large to be processed. |
FINGERPRINT_AUTH_TIP_PARTIAL | 3 | Incomplete fingerprint image is detected. |
FINGERPRINT_AUTH_TIP_TOO_FAST | 4 | The fingerprint image is incomplete due to fast movement. |
FINGERPRINT_AUTH_TIP_TOO_SLOW | 5 | Failed to obtain the fingerprint image because the finger seldom moves. |
UserAuthType8+
Enumerates the identity authentication types.
System capability: SystemCapability.UserIAM.UserAuth.Core
Name | Value | Description |
---|---|---|
PIN10+ | 1 | PIN authentication. |
FACE | 2 | Facial authentication. |
FINGERPRINT | 4 | Fingerprint authentication. |
AuthTrustLevel8+
Enumerates the trust levels of the authentication result.
System capability: SystemCapability.UserIAM.UserAuth.Core
Name | Value | Description |
---|---|---|
ATL1 | 10000 | Authentication trust level 1. The authentication of this level can identify individual users and provides limited liveness detection capabilities. It is usually used in service risk control and query of general personal data. |
ATL2 | 20000 | Authentication trust level 2. The authentication of this level can accurately identify individual users and provides regular liveness detection capabilities. It is usually used in scenarios such as logins to apps and keeping a device in unlocked state. |
ATL3 | 30000 | Authentication trust level 3. The authentication of this level can accurately identify individual users and provides strong liveness detection capabilities. It is usually used in scenarios such as unlocking a device. |
ATL4 | 40000 | Authentication trust level 4. The authentication of this level can accurately identify individual users and provides powerful liveness detection capabilities. It is usually used in scenarios such as small-amount payment. |
userIAM_userAuth.getAuthenticator(deprecated)
getAuthenticator(): Authenticator
Obtains an Authenticator instance for user authentication.
NOTE
This API is deprecated since API version 8. You are advised to use constructor.
System capability: SystemCapability.UserIAM.UserAuth.Core
Return value
Type | Description |
---|---|
Authenticator | Authenticator instance obtained. |
Example
import userIAM_userAuth from '@ohos.userIAM.userAuth';
let authenticator = userIAM_userAuth.getAuthenticator();
Authenticator(deprecated)
Defines the Authenticator object.
NOTE
This API is deprecated since API version 8. Use UserAuth instead.
execute(deprecated)
execute(type: AuthType, level: SecureLevel, callback: AsyncCallback<number>): void
Performs user authentication. This API uses asynchronous callback to return the result.
NOTE
This API is deprecated since API version 8. You are advised to use auth.
Required permissions: ohos.permission.ACCESS_BIOMETRIC
System capability: SystemCapability.UserIAM.UserAuth.Core
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
type | AuthType | Yes | Authentication type. Only FACE_ONLY is supported. ALL is reserved and not supported by the current version. |
level | SecureLevel | Yes | Security level of the authentication. It can be S1 (lowest), S2, S3, or S4 (highest). Devices capable of 3D facial recognition support S3 and lower-level authentication. Devices capable of 2D facial recognition support S2 and lower-level authentication. |
callback | AsyncCallback<number> | Yes | Callback used to return the result. |
Parameters returned in callback
Type | Description |
---|---|
number | Authentication result. For details, see AuthenticationResult. |
Example
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>
Performs user authentication. This API uses a promise to return the result.
NOTE
This API is deprecated since API version 8. You are advised to use auth.
Required permissions: ohos.permission.ACCESS_BIOMETRIC
System capability: SystemCapability.UserIAM.UserAuth.Core
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
type | AuthType | Yes | Authentication type. Only FACE_ONLY is supported. ALL is reserved and not supported by the current version. |
level | SecureLevel | Yes | Security level of the authentication. It can be S1 (lowest), S2, S3, or S4 (highest). Devices capable of 3D facial recognition support S3 and lower-level authentication. Devices capable of 2D facial recognition support S2 and lower-level authentication. |
Return value
Type | Description |
---|---|
Promise<number> | Promise used to return the authentication result, which is a number. For details, see AuthenticationResult. |
Example
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)
Enumerates the authentication results.
NOTE
This object is discarded since API version 8. You are advised to use ResultCode.
System capability: SystemCapability.UserIAM.UserAuth.Core
Name | Value | Description |
---|---|---|
NO_SUPPORT | -1 | The device does not support the current authentication mode. |
SUCCESS | 0 | The authentication is successful. |
COMPARE_FAILURE | 1 | The feature comparison failed. |
CANCELED | 2 | The authentication was canceled by the user. |
TIMEOUT | 3 | The authentication has timed out. |
CAMERA_FAIL | 4 | The camera failed to start. |
BUSY | 5 | The authentication service is not available. Try again later. |
INVALID_PARAMETERS | 6 | The authentication parameters are invalid. |
LOCKED | 7 | The user account is locked because the number of authentication failures has reached the threshold. |
NOT_ENROLLED | 8 | No authentication credential is registered. |
GENERAL_ERROR | 100 | Other errors. |
你可能感兴趣的鸿蒙文章
harmony 鸿蒙System Common Events (To Be Deprecated Soon)
harmony 鸿蒙System Common Events
harmony 鸿蒙API Reference Document Description
harmony 鸿蒙Enterprise Device Management Overview (for System Applications Only)
harmony 鸿蒙BundleStatusCallback
harmony 鸿蒙@ohos.bundle.innerBundleManager (innerBundleManager)
harmony 鸿蒙@ohos.distributedBundle (Distributed Bundle Management)
harmony 鸿蒙@ohos.bundle (Bundle)
harmony 鸿蒙@ohos.enterprise.EnterpriseAdminExtensionAbility (EnterpriseAdminExtensionAbility)
- 所属分类: 后端技术
- 本文标签:
热门推荐
-
2、 - 优质文章
-
3、 gate.io
-
8、 golang
-
9、 openharmony
-
10、 Vue中input框自动聚焦