| type | 'activate' \| 'activating' | Yes | Type of the event to unsubscribe from. The value **activate** means an event indicating that an OS account is activated, and **activating** means an event indicating that an OS account is being activated.|
| name | string | Yes | Subscription name, which can be customized. The value cannot be empty or exceed 1024 bytes, and must be the same as the value passed by **on()**.|
| callback | Callback<number> | No | Callback for the OS account activation state events. By default, no value is passed, which unsubscribes from all the callbacks for the OS account activation state events. |
| callback | Callback<number> | No | Callback for the OS account activation state events. By default, this parameter is left empty, which unsubscribes from all the callbacks for the OS account activation state events. |
**Error codes**
...
...
@@ -4107,7 +4107,7 @@ Performs authentication of the current user. This API uses an asynchronous callb
| ID| Error Message |
| -------- | --------------------- |
| 12300001 | System service exception. |
| 12300002 | Invalid challenge or authType or authTrustLevel. |
| 12300002 | Invalid challenge, authType, or authTrustLevel. |
| 12300101 | Credential is incorrect. |
| 12300105 | Unsupported authTrustLevel. |
| 12300106 | Unsupported authType. |
...
...
@@ -4166,7 +4166,7 @@ Performs authentication of the specified user. This API uses an asynchronous cal
| ID| Error Message |
| -------- | --------------------- |
| 12300001 | System service exception. |
| 12300002 | Invalid userId or challenge or authType or authTrustLevel. |
| 12300002 | Invalid userId, challenge, authType, or authTrustLevel. |
| 12300101 | Credential is incorrect. |
| 12300105 | Unsupported authTrustLevel. |
| 12300106 | Unsupported authType. |
...
...
@@ -5649,7 +5649,7 @@ Obtains authentication information of the specified type. This API uses a promis
| authType | [AuthType](#authtype8) | No | Authentication type. By default, no value is passed, which means to obtain information about all authentication types.|
| authType | [AuthType](#authtype8) | No | Authentication type. By default, this parameter is left blank, which means to obtain information about all authentication types.|
@@ -15,15 +15,15 @@ System service works abnormally.
**Possible Causes**
The possible causes are as follows:
1. The account management service cannot start properly.
2. The IPC object for account management cannot be obtained.
3. The services on which the account management depends cannot start properly, or the IPC object on which the account management depends cannot be obtained.
4. The service is not initialized.
5. The disk space is insufficient.
6. The file read or write fails.
7. Directories cannot be created.
8. Files cannot be created or deleted.
9. The database cannot be read or written.
- The account management service cannot start properly.
- The IPC object for account management cannot be obtained.
- The services on which the account management depends cannot start properly, or the IPC object on which the account management depends cannot be obtained.
- The service is not initialized.
- The disk space is insufficient.
- The file read or write fails.
- Directories cannot be created.
- Files cannot be created or deleted.
- The database cannot be read or written.
**Solution**
...
...
@@ -38,30 +38,30 @@ Invalid parameter.
**Possible Causes**
The possible causes are as follows:
1. The user name is empty.
2. The user name of the OS account exceeds 1024 characters.
3. The user name of the distributed account exceeds 256 characters.
4. The OS account ID is less than 0 or 100, or greater than 1099.
5. The distributed account ID exceeds 512 characters.
6. The event type passed in for the distributed account is not supported.
7. The domain name is empty.
8. The domain name exceeds 128 characters.
9. The domain account is empty.
10. The domain account exceeds 512 characters.
11. The constraint is empty.
12. The constraint exceeds 128 characters.
13. Invalid authentication or query parameters are passed in.
14. The profile photo string of the OS account exceeds 4 KB.
15. The profile photo string of the distributed account exceeds 2 MB.
16. The images are not in .jpg or .png format.
17. The app account name exceeds 512 characters.
18. The authentication type exceeds 1024 characters.
19. The token exceeds 1024 characters.
20. The key exceeds 1024 characters.
21. The custom data exceeds 1024 characters.
22. The token is invalid.
23. The context ID is invalid.
24. The credential ID is invalid.
- The user name is empty.
- The user name of the OS account exceeds 1024 characters.
- The user name of the distributed account exceeds 256 characters.
- The OS account ID is less than 0 or 100, or greater than 1099.
- The distributed account ID exceeds 512 characters.
- The event type passed in for the distributed account is not supported.
- The domain name is empty.
- The domain name exceeds 128 characters.
- The domain account is empty.
- The domain account exceeds 512 characters.
- The constraint is empty.
- The constraint exceeds 128 characters.
- Invalid authentication or query parameters are passed in.
- The profile photo string of the OS account exceeds 4 KB.
- The profile photo string of the distributed account exceeds 2 MB.
- The images are not in .jpg or .png format.
- The app account name exceeds 512 characters.
- The authentication type exceeds 1024 characters.
- The token exceeds 1024 characters.
- The key exceeds 1024 characters.
- The custom data exceeds 1024 characters.
- The token is invalid.
- The context ID is invalid.
- The credential ID is invalid.
**Solution**
...
...
@@ -76,17 +76,17 @@ The account does not exist.
**Possible Causes**
The possible causes are as follows:
1. The account to query, activate, or delete is not created.
2. The account to query, activate, or delete has been deleted.
3. The constraint, user name, or profile photo is set for an account that has been deleted.
4. The account to update is not created.
5. The access permission is to be set for an account that does not exist.
6. The password is to be set, deleted, or queried for an account that does not exist.
7. The token is to be set or deleted for an account that does not exist.
8. Additional information is to be set for an account that does not exist.
9. Credentials are to be set for an account that does not exist.
10. Custom data is to be set for an account that does not exist.
11. Distributed synchronization is to be enabled for an account that does not exist.
- The account to query, activate, or delete is not created.
- The account to query, activate, or delete has been deleted.
- The constraint, user name, or profile photo is set for an account that has been deleted.
- The account to update is not created.
- The access permission is to be set for an account that does not exist.
- The password is to be set, deleted, or queried for an account that does not exist.
- The token is to be set or deleted for an account that does not exist.
- Additional information is to be set for an account that does not exist.
- Credentials are to be set for an account that does not exist.
- Custom data is to be set for an account that does not exist.
- Distributed synchronization is to be enabled for an account that does not exist.
**Solution**
...
...
@@ -148,7 +148,7 @@ A maximum of 1,000 OS accounts or app accounts can be created.
Delete the accounts that are no longer used, and try again.
## 12300008 The Account Is Restricted
## 12300008 Account Restricted
**Error Message**
...
...
@@ -157,9 +157,9 @@ The specified account is restricted.
**Possible Causes**
The possible causes are as follows:
1. The account to delete is a reserved account of the system.
2. The constraint source type to query belongs to a reserved account.
3. The ID of the account to create is 0 to 100.
- The account to delete is a reserved account of the system.
- The constraint source type to query belongs to a reserved account.
- The ID of the account to create is 0 to 100.
**Solution**
...
...
@@ -188,8 +188,8 @@ The account service does not respond.
**Possible Causes**
The possible causes are as follows:
1. Repeated requests, such as the requests for activating an account or applying the same settings, are submitted in a short period of time.
2. When the number of authentication sessions for app accounts reaches 256, new authentication requests cannot be processed.
- Repeated requests, such as the requests for activating an account or applying the same settings, are submitted in a short period of time.
- When the number of authentication sessions for app accounts reaches 256, new authentication requests cannot be processed.
**Solution**
...
...
@@ -223,6 +223,27 @@ The event listener to unregister has not been registered.
Only registered event listeners can be unregistered.
## 12300013 Network Exception
**Error Message**
The network exception.
**Possible Causes**
The possible causes are as follows:
1. The device is not connected to the network.
2. The network connection is abnormal.
3. The app does not have the network access permission.
4. Unidentified network error.
**Solution**
1. Connect the device to the network.
2. Check that the network connection is normal.
3. Check that the application has the network access permission.
4. Perform related operations again.
## 12300101 Incorrect Credential
**Error Message**
...
...
@@ -232,9 +253,9 @@ The credential is incorrect.
**Possible Causes**
The possible causes are as follows:
1. An incorrect password is entered.
2. The biological feature does not match the feature enrolled.
2. The token is invalid.
- An incorrect password is entered.
- The biological feature does not match the feature enrolled.
- The token is invalid.
**Solution**
...
...
@@ -249,9 +270,9 @@ The credential does not exist.
**Possible Causes**
The possible causes are as follows:
1. The credential to authenticate has not been enrolled.
2. The credential to query has not been enrolled.
3. The credential to delete has not been enrolled.
- The credential to authenticate has not been enrolled.
- The credential to query has not been enrolled.
- The credential to delete has not been enrolled.
**Solution**
...
...
@@ -261,7 +282,7 @@ Check whether the credential has been enrolled.
**Error Message**
The crdential inputer already exists.
The credential inputer already exists.
**Possible Causes**
...
...
@@ -341,15 +362,19 @@ The session callback to query does not exist.
Use an opened session to query session callbacks.
## 12300109 Authentication Canceled
## 12300109 Authentication, Credential Enrollment, or Update Canceled
**Error Message**
The authentication is canceled.
The authentication, enrollment, update operation is canceled.
**Possible Causes**
The user cancels the authentication.
The possible causes are as follows:
- The user canceled the authentication.
- The user canceled the credential enrollment.
- The user canceled the update during the credential enrollment process.
**Solution**
...
...
@@ -395,8 +420,9 @@ The authentication service does not respond.
**Possible Causes**
The possible causes are as follows:
The total number of OS accounts being authenticated exceeds 5.
The authentication service of the third-party app does not respond.
- The total number of OS accounts being authenticated exceeds 5.
- The authentication service of the third-party app does not respond.
**Solution**
...
...
@@ -410,12 +436,12 @@ The account authentication service does not exist.
**Possible Causes**
For app accounts:
1. When an authentication is requested, the app does not support the authentication service.
2. When an account is added implicitly, the app does not support the authentication service.
3. When the credential of a specified account is verified, the app does not support the authentication service.
4. When the authenticator attributes are set for an app, the app does not support the authentication service.
5. When the account tags are checked, the specified app does not support the authentication service.
The possible causes for app accounts are as follows:
- When an authentication is requested, the app does not support the authentication service.
- When an account is added implicitly, the app does not support the authentication service.
- When the credential of a specified account is verified, the app does not support the authentication service.
- When the authenticator attributes are set for an app, the app does not support the authentication service.
- When the account tags are checked, the specified app does not support the authentication service.
**Solution**
...
...
@@ -447,12 +473,12 @@ The application does not exist.
**Possible Causes**
The possible causes are as follows:
1. The target app does not exist when the app permission is set.
2. The target app does not exist when the app permission is authorized.
- The target app does not exist when the app permission is set.
- The target app does not exist when the app permission is authorized.
**Solution**
Check that the target app has been installed and use the bundle of the app.
Check that the target app has been installed, and use the bundle of the app.
## 12400002 Custom Data Not Exist
...
...
@@ -508,5 +534,4 @@ The number of bundles in the authorization list has reached 1024.
**Solution**
Revoke authorization from the apps that do not require the authorization and try again.
Revoke authorization from the apps that do not require the authorization and try again.
