# OS Account Management The **osAccount** module provides basic capabilities for managing operating system (OS) accounts, including adding, deleting, querying, setting, subscribing to, and enabling an OS account, and storing OS account data to disks. > **NOTE**
> The initial APIs of this module are supported since API version 7. Newly added APIs will be marked with a superscript to indicate their earliest API version. ## Modules to Import ```js import account_osAccount from '@ohos.account.osAccount'; ``` ## account_osAccount.getAccountManager getAccountManager(): AccountManager Obtains an **AccountManager** instance. **System capability**: SystemCapability.Account.OsAccount **Return value** | Type | Description | | --------------------------------- | ------------------------ | | [AccountManager](#accountmanager) | Obtains an **AccountManager** instance.| **Example** ```js const accountManager = account_osAccount.getAccountManager(); ``` ## OsAccountType Enumerates OS account types. **System capability**: SystemCapability.Account.OsAccount | Name | Default Value| Description | | ------ | ------ | ------------ | | ADMIN | 0 | Administrator account| | NORMAL | 1 | Normal account | | GUEST | 2 | Guest account | ## AccountManager Provides methods to manage OS accounts. ### activateOsAccount activateOsAccount(localId: number, callback: AsyncCallback<void>): void Activates an OS account. This API uses an asynchronous callback to return the result. This is a system API and cannot be called by third-party applications. **Required permissions**: ohos.permission.INTERACT_ACROSS_LOCAL_ACCOUNTS_EXTENSION **System capability**: SystemCapability.Account.OsAccount **Parameters** | Name | Type | Mandatory| Description | | -------- | ------------------------- | ---- | -------------------- | | localId | number | Yes | ID of the OS account to activate.| | callback | AsyncCallback<void> | Yes | Callback used to return the result. | **Example**: Activate OS account 100. ```js const accountManager = account_osAccount.getAccountManager(); var localId = 100; accountManager.activateOsAccount(localId, (err)=>{ console.log("activateOsAccount err:" + JSON.stringify(err)); }); ``` ### activateOsAccount activateOsAccount(localId: number): Promise<void> Activates an OS account. This API uses a promise to return the result. This is a system API and cannot be called by third-party applications. **Required permissions**: ohos.permission.INTERACT_ACROSS_LOCAL_ACCOUNTS_EXTENSION **System capability**: SystemCapability.Account.OsAccount **Parameters** | Name | Type | Mandatory| Description | | ------- | ------ | ---- | -------------------- | | localId | number | Yes | ID of the OS account to activate.| **Return value** | Type | Description | | :------------------ | :---------------------------------- | | Promise<void> | Promise used to return the result.| **Example**: Activate OS account 100. ```js const accountManager = account_osAccount.getAccountManager(); var localId = 100; accountManager.activateOsAccount(localId).then(() => { console.log("activateOsAccount success"); }).catch((err) => { console.log("activateOsAccount err:" + JSON.stringify(err)); }); ``` ### isMultiOsAccountEnable isMultiOsAccountEnable(callback: AsyncCallback<boolean>): void Checks whether multiple OS accounts are supported. This API uses an asynchronous callback to return the result. **System capability**: SystemCapability.Account.OsAccount **Parameters** | Name | Type | Mandatory| Description | | -------- | ---------------------------- | ---- | --------------------------------------------------- | | callback | AsyncCallback<boolean> | Yes | Callback used to return the result. If multiple OS accounts are supported, **true** will be returned. Otherwise, **false** will be returned.| **Example** ```js const accountManager = account_osAccount.getAccountManager(); accountManager.isMultiOsAccountEnable((err, isEnabled) => { console.log("isMultiOsAccountEnable err: " + JSON.stringify(err)); console.log('isMultiOsAccountEnable isEnabled: ' + isEnabled); }); ``` ### isMultiOsAccountEnable isMultiOsAccountEnable(): Promise<boolean> Checks whether multiple OS accounts are supported. This API uses a promise to return the result. **System capability**: SystemCapability.Account.OsAccount **Return value** | Type | Description | | :--------------------- | :----------------------------------------------------------- | | Promise<boolean> | Promise used to return the result. If multiple OS accounts are supported, **true** will be returned. Otherwise, **false** will be returned.| **Example** ```js const accountManager = account_osAccount.getAccountManager(); accountManager.isMultiOsAccountEnable().then((isEnabled) => { console.log('isMultiOsAccountEnable, isEnabled: ' + isEnabled); }).catch((err) => { console.log("isMultiOsAccountEnable err: " + JSON.stringify(err)); }); ``` ### isOsAccountActived isOsAccountActived(localId: number, callback: AsyncCallback<boolean>): void Checks whether an OS account is activated. This API uses an asynchronous callback to return the result. **Required permissions**: ohos.permission.MANAGE_LOCAL_ACCOUNTS or ohos.permission.INTERACT_ACROSS_LOCAL_ACCOUNTS **System capability**: SystemCapability.Account.OsAccount **Parameters** | Name | Type | Mandatory| Description | | -------- | ---------------------------- | ---- | ------------------------------------------------- | | localId | number | Yes | ID of the target OS account. | | callback | AsyncCallback<boolean> | Yes | Callback used to return the result. If the OS account is activated, **true** will be returned. Otherwise, **false** will be returned.| **Example**: Check whether OS account 100 is activated. ```js const accountManager = account_osAccount.getAccountManager(); var osLocalId = 100; accountManager.isOsAccountActived(osLocalId, (err, isActive)=>{ console.log("isOsAccountActived err:" + JSON.stringify(err)); console.log("isOsAccountActived isActive:" + isActive); }); ``` ### isOsAccountActived isOsAccountActived(localId: number): Promise<boolean> Checks whether an OS account is activated. This API uses a promise to return the result. **Required permissions**: ohos.permission.MANAGE_LOCAL_ACCOUNTS or ohos.permission.INTERACT_ACROSS_LOCAL_ACCOUNTS **System capability**: SystemCapability.Account.OsAccount **Parameters** | Name | Type | Mandatory| Description | | ------- | ------ | ---- | ------------ | | localId | number | Yes | ID of the target OS account.| **Return value** | Type | Description | | :--------------------- | :----------------------------------------------------------- | | Promise<boolean> | Promise used to return the result. If the OS account is activated, **true** will be returned. Otherwise, **false** will be returned.| **Example**: Check whether OS account 100 is activated. ```js const accountManager = account_osAccount.getAccountManager(); var osLocalId = 100; accountManager.isOsAccountActived(osLocalId).then((isActive) => { console.log('isOsAccountActived, isActive: ' + isActive); }).catch((err) => { console.log("isOsAccountActived err: " + JSON.stringify(err)); }); ``` ### isOsAccountConstraintEnable isOsAccountConstraintEnable(localId: number, constraint: string, callback: AsyncCallback<boolean>): void Checks whether the specified constraint is enabled for an OS account. This API uses an asynchronous callback to return the result. **Required permissions**: ohos.permission.MANAGE_LOCAL_ACCOUNTS **System capability**: SystemCapability.Account.OsAccount **Parameters** | Name | Type | Mandatory| Description | | ---------- | ---------------------------- | ---- | ------------------------------------------------- | | localId | number | Yes | ID of the target OS account. | | constraint | string | Yes | [Constraint](#constraints) specified. | | callback | AsyncCallback<boolean> | Yes | Callback used to return the result. If the constraint is enabled for the OS account, **true** will be returned. Otherwise, **false** will be returned.| **Example**: Check whether OS account 100 is forbidden to use Wi-Fi. ```js const accountManager = account_osAccount.getAccountManager(); var localId = 100; accountManager.isOsAccountConstraintEnable(localId, "constraint.wifi", (err, isConstraintEnabled)=>{ console.log("isOsAccountConstraintEnable err:" + JSON.stringify(err)); console.log("isOsAccountConstraintEnable isConstraintEnabled:" + isConstraintEnabled); }); ``` ### isOsAccountConstraintEnable isOsAccountConstraintEnable(localId: number, constraint: string): Promise<boolean> Checks whether the specified constraint is enabled for an OS account. This API uses a promise to return the result. **Required permissions**: ohos.permission.MANAGE_LOCAL_ACCOUNTS **System capability**: SystemCapability.Account.OsAccount **Parameters** | Name | Type | Mandatory| Description | | ---------- | ------ | ---- | ------------------------------------- | | localId | number | Yes | ID of the target OS account. | | constraint | string | Yes | [Constraint](#constraints) specified.| **Return value** | Type | Description | | :--------------------- | :----------------------------------------------------------- | | Promise<boolean> | Promise used to return the result. If the constraint is enabled for the OS account, **true** will be returned. Otherwise, **false** will be returned.| **Example**: Check whether OS account 100 is forbidden to use Wi-Fi. ```js const accountManager = account_osAccount.getAccountManager(); var localId = 100; accountManager.isOsAccountConstraintEnable(localId, "constraint.wifi").then((isConstraintEnabled) => { console.log('isOsAccountConstraintEnable, isConstraintEnabled: ' + isConstraintEnabled); }).catch((err) => { console.log("isOsAccountConstraintEnable err: " + JSON.stringify(err)); }); ``` ### isTestOsAccount isTestOsAccount(callback: AsyncCallback<boolean>): void Checks whether this OS account is a test account. This API uses an asynchronous callback to return the result. **System capability**: SystemCapability.Account.OsAccount **Parameters** | Name | Type | Mandatory| Description | | -------- | ---------------------------- | ---- | ----------------------------------------------- | | callback | AsyncCallback<boolean> | Yes | Callback used to return the result. If the account is a test account, **true** will be returned. Otherwise, **false** will be returned.| **Example** ```js const accountManager = account_osAccount.getAccountManager(); accountManager.isTestOsAccount((err, isTest) => { console.log("isTestOsAccount err: " + JSON.stringify(err)); console.log('isTestOsAccount isTest: ' + isTest); }); ``` ### isTestOsAccount isTestOsAccount(): Promise<boolean> Checks whether this OS account is a test account. This API uses a promise to return the result. **System capability**: SystemCapability.Account.OsAccount **Return value** | Type | Description | | :--------------------- | :----------------------------------------------------------- | | Promise<boolean> | Promise used to return the result. If the account is a test account, **true** will be returned. Otherwise, **false** will be returned.| **Example** ```js const accountManager = account_osAccount.getAccountManager(); accountManager.isTestOsAccount().then((isTest) => { console.log('isTestOsAccount, isTest: ' + isTest); }).catch((err) => { console.log("isTestOsAccount err: " + JSON.stringify(err)); }); ``` ### isOsAccountVerified isOsAccountVerified(callback: AsyncCallback<boolean>): void Checks whether this OS account has been verified. This API uses an asynchronous callback to return the result. **System capability**: SystemCapability.Account.OsAccount **Parameters** | Name | Type | Mandatory| Description | | -------- | ---------------------------- | ---- | ------------------------------------------- | | callback | AsyncCallback<boolean> | Yes | Callback used to return the result. If the OS account has been verified, **true** will be returned. Otherwise, **false** will be returned.| **Example** ```js const accountManager = account_osAccount.getAccountManager(); accountManager.isOsAccountVerified((err, isVerified) => { console.log("isOsAccountVerified err: " + JSON.stringify(err)); console.log('isOsAccountVerified isVerified: ' + isVerified); }); ``` ### isOsAccountVerified isOsAccountVerified(localId: number, callback: AsyncCallback<boolean>): void Checks whether an OS account has been verified. This API uses an asynchronous callback to return the result. **Required permissions**: ohos.permission.MANAGE_LOCAL_ACCOUNTS or ohos.permission.INTERACT_ACROSS_LOCAL_ACCOUNTS **System capability**: SystemCapability.Account.OsAccount **Parameters** | Name | Type | Mandatory| Description | | -------- | ---------------------------- | ---- | ------------------------------------------- | | localId | number | No | ID of the target OS account. | | callback | AsyncCallback<boolean> | Yes | Callback used to return the result. If the OS account has been verified, **true** will be returned. Otherwise, **false** will be returned.| **Example** ```js const accountManager = account_osAccount.getAccountManager(); accountManager.isOsAccountVerified((err, isVerified) => { console.log("isOsAccountVerified err: " + JSON.stringify(err)); console.log('isOsAccountVerified isVerified: ' + isVerified); }); ``` ### isOsAccountVerified isOsAccountVerified(localId?: number): Promise<boolean> Checks whether an OS account has been verified. This API uses a promise to return the result. **Required permissions**: ohos.permission.MANAGE_LOCAL_ACCOUNTS or ohos.permission.INTERACT_ACROSS_LOCAL_ACCOUNTS **System capability**: SystemCapability.Account.OsAccount **Parameters** | Name | Type | Mandatory| Description | | ------- | ------ | ---- | ------------------ | | localId | number | No | ID of the target OS account.| **Return value** | Type | Description | | :--------------------- | :----------------------------------------------------------- | | Promise<boolean> | Promise used to return the result. If the OS account has been verified, **true** will be returned. Otherwise, **false** will be returned.| **Example** ```js const accountManager = account_osAccount.getAccountManager(); accountManager.isOsAccountVerified().then((isVerified) => { console.log('isOsAccountVerified, isVerified: ' + isVerified); }).catch((err) => { console.log("isOsAccountVerified err: " + JSON.stringify(err)); }); ``` ### removeOsAccount removeOsAccount(localId: number, callback: AsyncCallback<void>): void Removes an OS account. This API uses an asynchronous callback to return the result. This is a system API and cannot be called by third-party applications. **Required permissions**: ohos.permission.MANAGE_LOCAL_ACCOUNTS **System capability**: SystemCapability.Account.OsAccount **Parameters** | Name | Type | Mandatory| Description | | -------- | ------------------------- | ---- | -------------------- | | localId | number | Yes | ID of the OS account to remove.| | callback | AsyncCallback<void> | Yes | Callback used to return the result. | **Example** ```js const accountManager = account_osAccount.getAccountManager(); accountManager.createOsAccount("testAccountName", account_osAccount.OsAccountType.NORMAL, (err, osAccountInfo) => { accountManager.removeOsAccount(osAccountInfo.localId, (err)=>{ console.log("removeOsAccount err:" + JSON.stringify(err)); }); }); ``` ### removeOsAccount removeOsAccount(localId: number): Promise<void> Removes an OS account. This API uses a promise to return the result. This is a system API and cannot be called by third-party applications. **Required permissions**: ohos.permission.MANAGE_LOCAL_ACCOUNTS **System capability**: SystemCapability.Account.OsAccount **Parameters** | Name | Type | Mandatory| Description | | ------- | ------ | ---- | -------------------- | | localId | number | Yes | ID of the OS account to remove.| **Return value** | Type | Description | | :------------------ | :---------------------------------- | | Promise<void> | Promise used to return the result.| **Example** ```js const accountManager = account_osAccount.getAccountManager(); accountManager.createOsAccount("testAccountName", account_osAccount.OsAccountType.NORMAL, (err, osAccountInfo)=>{ accountManager.removeOsAccount(osAccountInfo.localId).then(() => { console.log('removeOsAccount Success'); }).catch(() => { console.log("removeOsAccount err: " + JSON.stringify(err)); }); }); ``` ### setOsAccountConstraints setOsAccountConstraints(localId: number, constraints: Array<string>, enable: boolean,callback: AsyncCallback<void>): void Sets or removes constraints for an OS account. This API uses an asynchronous callback to return the result. This is a system API and cannot be called by third-party applications. **Required permissions**: ohos.permission.MANAGE_LOCAL_ACCOUNTS **System capability**: SystemCapability.Account.OsAccount **Parameters** | Name | Type | Mandatory| Description | | ----------- | ------------------------- | ---- | -------------------------------------------- | | localId | number | Yes | ID of the target OS account. | | constraints | Array<string> | Yes | List of [constraints](#constraints) to set or remove.| | enable | boolean | Yes | Set or remove constraints. The value **true** means to set constraints, and **false** means to remove constraints. | | callback | AsyncCallback<void> | Yes | Callback used to return the result. | **Example**: Disable Wi-Fi for OS account 100. ```js const accountManager = account_osAccount.getAccountManager(); var localId = 100; accountManager.setOsAccountConstraints(localId, ["constraint.wifi"], true, (err)=>{ console.log("setOsAccountConstraints err:" + JSON.stringify(err)); }); ``` ### setOsAccountConstraints setOsAccountConstraints(localId: number, constraints: Array<string>, enable: boolean): Promise<void> Sets or removes constraints for an OS account. This API uses a promise to return the result. This is a system API and cannot be called by third-party applications. **Required permissions**: ohos.permission.MANAGE_LOCAL_ACCOUNTS **System capability**: SystemCapability.Account.OsAccount **Parameters** | Name | Type | Mandatory| Description | | ----------- | ------------------- | ---- | -------------------------------------------- | | localId | number | Yes | ID of the target OS account. | | constraints | Array<string> | Yes | List of [constraints](#constraints) to set or remove.| | enable | boolean | Yes | Set or remove constraints. The value **true** means to set constraints, and **false** means to remove constraints. | **Return value** | Type | Description | | :------------------ | :---------------------------------- | | Promise<void> | Promise used to return the result.| **Example**: Remote the constraint on the use of Wi-Fi for OS account 100. ```js const accountManager = account_osAccount.getAccountManager(); var localId = 100; accountManager.setOsAccountConstraints(localId, ["constraint.location.set"], false).then(() => { console.log('setOsAccountConstraints Success'); }).catch((err) => { console.log("setOsAccountConstraints err: " + JSON.stringify(err)); }); ``` ### setOsAccountName setOsAccountName(localId: number, localName: string, callback: AsyncCallback<void>): void Sets a name for an OS account. This API uses an asynchronous callback to return the result. This is a system API and cannot be called by third-party applications. **Required permissions**: ohos.permission.MANAGE_LOCAL_ACCOUNTS **System capability**: SystemCapability.Account.OsAccount **Parameters** | Name | Type | Mandatory| Description | | :-------- | ------------------------- | ---- | ------------ | | localId | number | Yes | ID of the target OS account.| | localName | string | Yes | Account name to set. | | callback | AsyncCallback<void> | Yes | Callback used to return the result. | **Example**: Set the name of OS account 100 to **demoName**. ```js const accountManager = account_osAccount.getAccountManager(); var localId = 100; var newName = "demoName"; accountManager.setOsAccountName(localId, newName, (err)=>{ console.debug("setOsAccountName err:" + JSON.stringify(err)); }); ``` ### setOsAccountName setOsAccountName(localId: number, localName: string): Promise<void> Sets a name for an OS account. This API uses a promise to return the result. This is a system API and cannot be called by third-party applications. **Required permissions**: ohos.permission.MANAGE_LOCAL_ACCOUNTS **System capability**: SystemCapability.Account.OsAccount **Parameters** | Name | Type | Mandatory| Description | | --------- | ------ | ---- | ------------ | | localId | number | Yes | ID of the target OS account.| | localName | string | Yes | Account name to set. | **Return value** | Type | Description | | :------------------ | :---------------------------------- | | Promise<void> | Promise used to return the result.| **Example**: Set the name of OS account 100 to **demoName**. ```js const accountManager = account_osAccount.getAccountManager(); var localId = 100; var nameLimit = "demoName"; accountManager.setOsAccountName(localId, nameLimit).then(() => { console.log('setOsAccountName Success'); }).catch((err) => { console.log("setOsAccountName err: " + JSON.stringify(err)); }); ``` ### getCreatedOsAccountsCount getCreatedOsAccountsCount(callback: AsyncCallback<number>): void Obtains the number of OS accounts created. This API uses an asynchronous callback to return the result. **Required permissions**: ohos.permission.MANAGE_LOCAL_ACCOUNTS **System capability**: SystemCapability.Account.OsAccount **Parameters** | Name | Type | Mandatory| Description | | -------- | --------------------------- | ---- | ------------------------------------------ | | callback | AsyncCallback<number> | Yes | Callback used to return the number of OS accounts created.| **Example** ```js const accountManager = account_osAccount.getAccountManager(); accountManager.getCreatedOsAccountsCount((err, accountCnt)=>{ console.log("obtains the number of all os accounts created err:" + JSON.stringify(err)); console.log("obtains the number of all os accounts created accountCnt:" + accountCnt); }); ``` ### getCreatedOsAccountsCount getCreatedOsAccountsCount(): Promise<number> Obtains the number of OS accounts created. This API uses a promise to return the result. **Required permissions**: ohos.permission.MANAGE_LOCAL_ACCOUNTS **System capability**: SystemCapability.Account.OsAccount **Return value** | Type | Description | | :-------------------- | :----------------------------------------------------------- | | Promise<number> | Promise used to return the number of OS accounts created.| **Example** ```js const accountManager = account_osAccount.getAccountManager(); accountManager.getCreatedOsAccountsCount().then((accountCnt) => { console.log('getCreatedOsAccountsCount, accountCnt: ' + accountCnt); }).catch((err) => { console.log("getCreatedOsAccountsCount err: " + JSON.stringify(err)); }); ``` ### getOsAccountLocalIdFromProcess getOsAccountLocalIdFromProcess(callback: AsyncCallback<number>): void Obtains the ID of the OS account to which the current process belongs. This API uses an asynchronous callback to return the result. **System capability**: SystemCapability.Account.OsAccount **Parameters** | Name | Type | Mandatory| Description | | -------- | --------------------------- | ---- | -------------------------------------------------- | | callback | AsyncCallback<number> | Yes | Callback used to return the account ID obtained.| **Example** ```js const accountManager = account_osAccount.getAccountManager(); accountManager.getOsAccountLocalIdFromProcess((err, accountID) => { console.log("getOsAccountLocalIdFromProcess err: " + JSON.stringify(err)); console.log('getOsAccountLocalIdFromProcess accountID: ' + accountID); }); ``` ### getOsAccountLocalIdFromProcess getOsAccountLocalIdFromProcess(): Promise<number> Obtains the ID of the OS account to which the current process belongs. This API uses a promise to return the result. **System capability**: SystemCapability.Account.OsAccount **Return value** | Type | Description | | :-------------------- | :----------------------------------------------------------- | | Promise<number> | Promise used to return the account ID obtained.| **Example** ```js const accountManager = account_osAccount.getAccountManager(); accountManager.getOsAccountLocalIdFromProcess().then((accountID) => { console.log('getOsAccountLocalIdFromProcess, accountID: ' + accountID); }).catch((err) => { console.log("getOsAccountLocalIdFromProcess err: " + JSON.stringify(err)); }); ``` ### getOsAccountLocalIdFromUid getOsAccountLocalIdFromUid(uid: number, callback: AsyncCallback<number>): void Obtains the OS account ID based on the process UID. This API uses an asynchronous callback to return the result. **System capability**: SystemCapability.Account.OsAccount **Parameters** | Name | Type | Mandatory| Description | | -------- | --------------------------- | ---- | --------------------------------------------- | | uid | number | Yes | Process UID. | | callback | AsyncCallback<number> | Yes | Callback used to return the OS account ID obtained.| **Example**: Obtain the ID of the OS account whose process UID is **12345678**. ```js const accountManager = account_osAccount.getAccountManager(); let uid = 12345678; accountManager.getOsAccountLocalIdFromUid(uid, (err, accountID) => { console.log("getOsAccountLocalIdFromUid err: " + JSON.stringify(err)); console.log('getOsAccountLocalIdFromUid: ' + accountID); }); ``` ### getOsAccountLocalIdFromUid getOsAccountLocalIdFromUid(uid: number): Promise<number> Obtains the OS account ID based on the process UID. This API uses a promise to return the result. **System capability**: SystemCapability.Account.OsAccount **Parameters** | Name| Type | Mandatory| Description | | ------ | ------ | ---- | --------- | | uid | number | Yes | Process UID.| **Return value** | Type | Description | | :-------------------- | :----------------------------------------------------------- | | Promise<number> | Promise used to return the OS account ID obtained.| **Example**: Obtain the ID of the OS account whose process UID is **12345678**. ```js const accountManager = account_osAccount.getAccountManager(); let uid = 12345678; accountManager.getOsAccountLocalIdFromUid(uid).then((accountID) => { console.log('getOsAccountLocalIdFromUid: ' + accountID); }).catch((err) => { console.log("getOsAccountLocalIdFromUid err: " + JSON.stringify(err)); }); ``` ### getOsAccountLocalIdFromDomain8+ getOsAccountLocalIdFromDomain(domainInfo: DomainAccountInfo, callback: AsyncCallback<number>): void Obtains the OS account ID based on domain account information. This API uses an asynchronous callback to return the result. **Required permissions**: ohos.permission.MANAGE_LOCAL_ACCOUNTS **System capability**: SystemCapability.Account.OsAccount **Parameters** | Name | Type | Mandatory| Description | | ---------- | --------------------------------------- | ---- | -------------------------------------------- | | domainInfo | [DomainAccountInfo](#domainaccountinfo8) | Yes | Domain account information. | | callback | AsyncCallback<number> | Yes | Callback used to return the ID of the OS account associated with the domain account.| **Example** ```js var domainInfo = {domain: "testDomain", accountName: "testAccountName"}; const accountManager = account_osAccount.getAccountManager(); accountManager.getOsAccountLocalIdFromDomain(domainInfo, (err, accountID) => { console.log("getOsAccountLocalIdFromDomain: " + JSON.stringify(err)); console.log('getOsAccountLocalIdFromDomain: ' + accountID); }); ``` ### getOsAccountLocalIdFromDomain8+ getOsAccountLocalIdFromDomain(domainInfo: DomainAccountInfo): Promise<number> Obtains the OS account ID based on domain account information. This API uses a promise to return the result. **Required permissions**: ohos.permission.MANAGE_LOCAL_ACCOUNTS **System capability**: SystemCapability.Account.OsAccount **Parameters** | Name | Type | Mandatory| Description | | ---------- | --------------------------------------- | ---- | ------------ | | domainInfo | [DomainAccountInfo](#domainaccountinfo8) | Yes | Domain account information.| **Return value** | Type | Description | | :-------------------- | :----------------------------------------------------------- | | Promise<number> | Promise used to return the ID of the OS account associated with the domain account.| **Example** ```js const accountManager = account_osAccount.getAccountManager(); var domainInfo = {domain: "testDomain", accountName: "testAccountName"}; accountManager.getOsAccountLocalIdFromDomain(domainInfo).then((accountID) => { console.log('getOsAccountLocalIdFromDomain: ' + accountID); }).catch((err) => { console.log("getOsAccountLocalIdFromDomain err: " + JSON.stringify(err)); }); ``` ### queryMaxOsAccountNumber queryMaxOsAccountNumber(callback: AsyncCallback<number>): void Obtains the maximum number of OS accounts that can be created. This API uses an asynchronous callback to return the result. This is a system API and cannot be called by third-party applications. **System capability**: SystemCapability.Account.OsAccount **Parameters** | Name | Type | Mandatory| Description | | -------- | --------------------------- | ---- | ------------------------------------------------ | | callback | AsyncCallback<number> | Yes | Callback used to return the maximum number of OS accounts that can be created.| **Example** ```js const accountManager = account_osAccount.getAccountManager(); accountManager.queryMaxOsAccountNumber((err, maxCnt)=>{ console.log("queryMaxOsAccountNumber err:" + JSON.stringify(err)); console.log("queryMaxOsAccountNumber maxCnt:" + maxCnt); }); ``` ### queryMaxOsAccountNumber queryMaxOsAccountNumber(): Promise<number> Obtains the maximum number of OS accounts that can be created. This API uses a promise to return the result. This is a system API and cannot be called by third-party applications. **System capability**: SystemCapability.Account.OsAccount **Return value** | Type | Description | | :-------------------- | :----------------------------------------------------------- | | Promise<number> | Promise used to return the maximum number of OS accounts that can be created.| **Example** ```js const accountManager = account_osAccount.getAccountManager(); accountManager.queryMaxOsAccountNumber().then((maxCnt) => { console.log('queryMaxOsAccountNumber, maxCnt: ' + maxCnt); }).catch((err) => { console.log("queryMaxOsAccountNumber err: " + JSON.stringify(err)); }); ``` ### getOsAccountAllConstraints getOsAccountAllConstraints(localId: number, callback: AsyncCallback<Array<string>>): void Obtains all constraints enabled for an OS account. This API uses an asynchronous callback to return the result. **Required permissions**: ohos.permission.MANAGE_LOCAL_ACCOUNTS **System capability**: SystemCapability.Account.OsAccount **Parameters** | Name | Type | Mandatory| Description | | -------- | ---------------------------------------- | ---- | ------------------------------------------------------------ | | localId | number | Yes | ID of the target OS account. | | callback | AsyncCallback<Array<string>> | Yes | Callback used to return all [constraints](#constraints) obtained.| **Example**: Obtain all constraints of OS account 100. ```js const accountManager = account_osAccount.getAccountManager(); var localId = 100; accountManager.getOsAccountAllConstraints(localId, (err, constraints)=>{ console.log("getOsAccountAllConstraints err:" + JSON.stringify(err)); console.log("getOsAccountAllConstraints:" + JSON.stringify(constraints)); }); ``` ### getOsAccountAllConstraints getOsAccountAllConstraints(localId: number): Promise<Array<string>> Obtains all constraints enabled for an OS account. This API uses a promise to return the result. **Required permissions**: ohos.permission.MANAGE_LOCAL_ACCOUNTS **System capability**: SystemCapability.Account.OsAccount **Parameters** | Name | Type | Mandatory| Description | | ------- | ------ | ---- | ------------ | | localId | number | Yes | ID of the target OS account.| **Return value** | Type | Description | | :--------------------------------- | :----------------------------------------------------------- | | Promise<Array<string>> | Promise used to return the [constraints](#constraints) obtained.| **Example**: Obtain all constraints of OS account 100. ```js const accountManager = account_osAccount.getAccountManager(); var localId = 100; accountManager.getOsAccountAllConstraints(localId).then((constraints) => { console.log("getOsAccountAllConstraints, constraints: " + constraints); }).catch((err) => { console.log("getOsAccountAllConstraints err: " + JSON.stringify(err)); }); ``` ### queryAllCreatedOsAccounts queryAllCreatedOsAccounts(callback: AsyncCallback<Array<OsAccountInfo>>): void Obtains information about all the OS accounts created. This API uses an asynchronous callback to return the result. This is a system API and cannot be called by third-party applications. **System capability**: SystemCapability.Account.OsAccount **Required permissions**: ohos.permission.MANAGE_LOCAL_ACCOUNTS **Parameters** | Name | Type | Mandatory| Description | | -------- | ------------------------------------------------------------ | ---- | -------------------------------------------------- | | callback | AsyncCallback<Array<[OsAccountInfo](#osaccountinfo)>> | Yes | Callback used to return information about OS accounts created.| **Example** ```js const accountManager = account_osAccount.getAccountManager(); accountManager.queryAllCreatedOsAccounts((err, accountArr)=>{ console.log("queryAllCreatedOsAccounts err:" + JSON.stringify(err)); console.log("queryAllCreatedOsAccounts accountArr:" + JSON.stringify(accountArr)); }); ``` ### queryAllCreatedOsAccounts queryAllCreatedOsAccounts(): Promise<Array<OsAccountInfo>> Obtains information about all the OS accounts created. This API uses a promise to return the result. This is a system API and cannot be called by third-party applications. **System capability**: SystemCapability.Account.OsAccount **Required permissions**: ohos.permission.MANAGE_LOCAL_ACCOUNTS **Return value** | Type | Description | | :---------------------------------------------------------- | :----------------------------------------------------------- | | Promise<Array<[OsAccountInfo](#osaccountinfo)>> | Promise used to return information about OS accounts created.| **Example** ```js const accountManager = account_osAccount.getAccountManager(); accountManager.queryAllCreatedOsAccounts().then((accountArr) => { console.log('queryAllCreatedOsAccounts, accountArr: ' + JSON.stringify(accountArr)); }).catch((err) => { console.log("queryAllCreatedOsAccounts err: " + JSON.stringify(err)); }); ``` ### queryActivatedOsAccountIds8+ queryActivatedOsAccountIds(callback: AsyncCallback<Array<number>>): void Obtains information about all activated OS accounts. This API uses an asynchronous callback to return the result. **System capability**: SystemCapability.Account.OsAccount **Parameters** | Name | Type | Mandatory| Description | | -------- | ---------------------------------------- | ---- | ------------------------------------------------------ | | callback | AsyncCallback<Array<number>> | Yes | Callback used to return information about activated OS accounts.| **Example** ```js const accountManager = account_osAccount.getAccountManager(); accountManager.queryActivatedOsAccountIds((err, idArray)=>{ console.log("queryActivatedOsAccountIds err:" + JSON.stringify(err)); console.log("queryActivatedOsAccountIds idArray length:" + idArray.length); for(var i=0;i8+ queryActivatedOsAccountIds(): Promise<Array<number>> Obtains information about all activated OS accounts. This API uses a promise to return the result. **System capability**: SystemCapability.Account.OsAccount **Return value** | Type | Description | | :--------------------------------- | :----------------------------------------------------------- | | Promise<Array<number>> | Promise used to return information about activated OS accounts.| **Example** ```js const accountManager = account_osAccount.getAccountManager(); accountManager.queryActivatedOsAccountIds().then((idArray) => { console.log('queryActivatedOsAccountIds, idArray: ' + idArray); }).catch((err) => { console.log("queryActivatedOsAccountIds err: " + JSON.stringify(err)); }); ``` ### createOsAccount createOsAccount(localName: string, type: OsAccountType, callback: AsyncCallback<OsAccountInfo>): void Creates an OS account. This API uses an asynchronous callback to return the result. This is a system API and cannot be called by third-party applications. **Required permissions**: ohos.permission.MANAGE_LOCAL_ACCOUNTS **System capability**: SystemCapability.Account.OsAccount **Parameters** | Name | Type | Mandatory| Description | | :-------- | ---------------------------------------------------- | ---- | ------------------------------------------ | | localName | string | Yes | Name of the OS account to create. | | type | [OsAccountType](#osaccounttype) | Yes | Type of the OS account to create. | | callback | AsyncCallback<[OsAccountInfo](#osaccountinfo)> | Yes | Callback used to return the OS account created.| **Example** ```js const accountManager = account_osAccount.getAccountManager(); accountManager.createOsAccount("testName", account_osAccount.OsAccountType.NORMAL, (err, osAccountInfo)=>{ console.log("createOsAccount err:" + JSON.stringify(err)); console.log("createOsAccount osAccountInfo:" + JSON.stringify(osAccountInfo)); }); ``` ### createOsAccount createOsAccount(localName: string, type: OsAccountType): Promise<OsAccountInfo> Creates an OS account. This API uses a promise to return the result. This is a system API and cannot be called by third-party applications. **Required permissions**: ohos.permission.MANAGE_LOCAL_ACCOUNTS **System capability**: SystemCapability.Account.OsAccount **Parameters** | Name | Type | Mandatory| Description | | --------- | ------------------------------- | ---- | ---------------------- | | localName | string | Yes | Name of the OS account to create.| | type | [OsAccountType](#osaccounttype) | Yes | Type of the OS account to create.| **Return value** | Type | Description | | :--------------------------------------------- | :----------------------------------------------------------- | | Promise<[OsAccountInfo](#osaccountinfo)> | Promise used to return the OS account created.| **Example** ```js const accountManager = account_osAccount.getAccountManager(); accountManager.createOsAccount("testAccountName", account_osAccount.OsAccountType.NORMAL).then((accountInfo) => { console.log("createOsAccount, accountInfo: " + JSON.stringify(accountInfo)); }).catch((err) => { console.log("createOsAccount err: " + JSON.stringify(err)); }); ``` ### createOsAccountForDomain8+ createOsAccountForDomain(type: OsAccountType, domainInfo: DomainAccountInfo, callback: AsyncCallback<OsAccountInfo>): void Creates an OS account and associates it with the specified domain account. This API uses an asynchronous callback to return the result. This is a system API and cannot be called by third-party applications. **Required permissions**: ohos.permission.MANAGE_LOCAL_ACCOUNTS **System capability**: SystemCapability.Account.OsAccount **Parameters** | Name | Type | Mandatory| Description | | :--------- | ---------------------------------------------------- | ---- | ------------------------------------------ | | type | [OsAccountType](#osaccounttype) | Yes | Type of the OS account to create. | | domainInfo | [DomainAccountInfo](#domainaccountinfo8) | Yes | Domain account information. | | callback | AsyncCallback<[OsAccountInfo](#osaccountinfo)> | Yes | Callback used to return the OS account created.| **Example** ```js const accountManager = account_osAccount.getAccountManager(); var domainInfo = {domain: "testDomain", accountName: "testAccountName"}; accountManager.createOsAccountForDomain(account_osAccount.OsAccountType.NORMAL, domainInfo, (err, osAccountInfo)=>{ console.log("createOsAccountForDomain err:" + JSON.stringify(err)); console.log("createOsAccountForDomain osAccountInfo:" + JSON.stringify(osAccountInfo)); }); ``` ### createOsAccountForDomain8+ createOsAccountForDomain(type: OsAccountType, domainInfo: DomainAccountInfo): Promise<OsAccountInfo> Creates an OS account and associates it with the specified domain account. This API uses a promise to return the result. This is a system API and cannot be called by third-party applications. **Required permissions**: ohos.permission.MANAGE_LOCAL_ACCOUNTS **System capability**: SystemCapability.Account.OsAccount **Parameters** | Name | Type | Mandatory| Description | | ---------- | --------------------------------------- | ---- | ---------------------- | | type | [OsAccountType](#osaccounttype) | Yes | Type of the OS account to create.| | domainInfo | [DomainAccountInfo](#domainaccountinfo8) | Yes | Domain account information. | **Return value** | Type | Description | | :--------------------------------------------- | :----------------------------------------------------------- | | Promise<[OsAccountInfo](#osaccountinfo)> | Promise used to return the OS account created.| **Example** ```js const accountManager = account_osAccount.getAccountManager(); var domainInfo = {domain: "testDomain", accountName: "testAccountName"}; accountManager.createOsAccountForDomain(account_osAccount.OsAccountType.NORMAL, domainInfo).then((accountInfo) => { console.log("createOsAccountForDomain, account info: " + JSON.stringify(accountInfo)); }).catch((err) => { console.log("createOsAccountForDomain err: " + JSON.stringify(err)); }); ``` ### queryCurrentOsAccount queryCurrentOsAccount(callback: AsyncCallback<OsAccountInfo>): void Obtains information about the OS account to which the current process belongs. This API uses an asynchronous callback to return the result. **Required permissions**: ohos.permission.MANAGE_LOCAL_ACCOUNTS **System capability**: SystemCapability.Account.OsAccount **Parameters** | Name | Type | Mandatory| Description | | -------- | ---------------------------------------------------- | ---- | ---------------------------------------------- | | callback | AsyncCallback<[OsAccountInfo](#osaccountinfo)> | Yes | Callback used to return information about the OS account obtained.| **Example** ```js const accountManager = account_osAccount.getAccountManager(); accountManager.queryCurrentOsAccount((err, curAccountInfo)=>{ console.log("queryCurrentOsAccount err:" + JSON.stringify(err)); console.log("queryCurrentOsAccount curAccountInfo:" + JSON.stringify(curAccountInfo)); }); ``` ### queryCurrentOsAccount queryCurrentOsAccount(): Promise<OsAccountInfo> Obtains information about the OS account to which the current process belongs. This API uses a promise to return the result. **Required permissions**: ohos.permission.MANAGE_LOCAL_ACCOUNTS **System capability**: SystemCapability.Account.OsAccount **Return value** | Type | Description | | :--------------------------------------------- | :----------------------------------------------------------- | | Promise<[OsAccountInfo](#osaccountinfo)> | Promise used to return information about the OS account obtained.| **Example** ```js const accountManager = account_osAccount.getAccountManager(); accountManager.queryCurrentOsAccount().then((accountInfo) => { console.log("queryCurrentOsAccount, accountInfo: " + JSON.stringify(accountInfo)); }).catch((err) => { console.log("queryCurrentOsAccount err: " + JSON.stringify(err)); }); ``` ### queryOsAccountById queryOsAccountById(localId: number, callback: AsyncCallback<OsAccountInfo>): void Obtains information about an OS account. This API uses an asynchronous callback to return the result. This is a system API and cannot be called by third-party applications. **Required permissions**: ohos.permission.MANAGE_LOCAL_ACCOUNTS or ohos.permission.INTERACT_ACROSS_LOCAL_ACCOUNTS_EXTENSION **System capability**: SystemCapability.Account.OsAccount **Parameters** | Name | Type | Mandatory| Description | | -------- | ---------------------------------------------------- | ---- | ---------------------------------------- | | localId | number | Yes | ID of the target OS account. | | callback | AsyncCallback<[OsAccountInfo](#osaccountinfo)> | Yes | Callback used to return the OS account information obtained.| **Example**: Query information about OS account 100. ```js const accountManager = account_osAccount.getAccountManager(); var localId = 100; accountManager.queryOsAccountById(localId, (err, accountInfo)=>{ console.log("queryOsAccountById err:" + JSON.stringify(err)); console.log("queryOsAccountById accountInfo:" + JSON.stringify(accountInfo)); }); ``` ### queryOsAccountById queryOsAccountById(localId: number): Promise<OsAccountInfo> Obtains information about an OS account. This API uses a promise to return the result. This is a system API and cannot be called by third-party applications. **Required permissions**: ohos.permission.MANAGE_LOCAL_ACCOUNTS or ohos.permission.INTERACT_ACROSS_LOCAL_ACCOUNTS_EXTENSION **System capability**: SystemCapability.Account.OsAccount **Parameters** | Name | Type | Mandatory| Description | | ------- | ------ | ---- | -------------------- | | localId | number | Yes | ID of the target OS account.| **Return value** | Type | Description | | :--------------------------------------------- | :----------------------------------------------------------- | | Promise<[OsAccountInfo](#osaccountinfo)> | Promise used to return the OS account information obtained.| **Example**: Query information about OS account 100. ```js const accountManager = account_osAccount.getAccountManager(); var localId = 100; accountManager.queryOsAccountById(localId).then((accountInfo) => { console.log("queryOsAccountById, accountInfo: " + JSON.stringify(accountInfo)); }).catch((err) => { console.log("queryOsAccountById err: " + JSON.stringify(err)); }); ``` ### getOsAccountTypeFromProcess getOsAccountTypeFromProcess(callback: AsyncCallback<OsAccountType>): void Obtains the type of the OS account to which the current process belongs. This API uses an asynchronous callback to return the result. **System capability**: SystemCapability.Account.OsAccount **Parameters** | Name | Type | Mandatory| Description | | -------- | ---------------------------------------------------- | ---- | ---------------------------------------------------- | | callback | AsyncCallback<[OsAccountType](#osaccounttype)> | Yes | Callback used to return the OS account type.| **Example** ```js const accountManager = account_osAccount.getAccountManager(); accountManager.getOsAccountTypeFromProcess((err, accountType) => { console.log("getOsAccountTypeFromProcess err: " + JSON.stringify(err)); console.log('getOsAccountTypeFromProcess accountType: ' + accountType); }); ``` ### getOsAccountTypeFromProcess getOsAccountTypeFromProcess(): Promise<OsAccountType> Obtains the type of the OS account to which the current process belongs. This API uses a promise to return the result. **System capability**: SystemCapability.Account.OsAccount **Return value** | Type | Description | | :--------------------------------------------- | :----------------------------------------------------------- | | Promise<[OsAccountType](#osaccounttype)> | Promise used to return the OS account type.| **Example** ```js const accountManager = account_osAccount.getAccountManager(); accountManager.getOsAccountTypeFromProcess().then((accountType) => { console.log('getOsAccountTypeFromProcess, accountType: ' + accountType); }).catch((err) => { console.log("getOsAccountTypeFromProcess err: " + JSON.stringify(err)); }); ``` ### getDistributedVirtualDeviceId getDistributedVirtualDeviceId(callback: AsyncCallback<string>): void Obtains the ID of this distributed virtual device. This API uses an asynchronous callback to return the result. **Required permissions**: ohos.permission.DISTRIBUTED_DATASYNC or ohos.permission.MANAGE_LOCAL_ACCOUNTS **System capability**: SystemCapability.Account.OsAccount **Parameters** | Name | Type | Mandatory| Description | | -------- | --------------------------- | ---- | ------------------------------------ | | callback | AsyncCallback<string> | Yes | Callback used to return the device ID obtained.| **Example** ```js const accountManager = account_osAccount.getAccountManager(); accountManager.getDistributedVirtualDeviceId((err, virtualID) => { console.log("getDistributedVirtualDeviceId err: " + JSON.stringify(err)); console.log('getDistributedVirtualDeviceId virtualID: ' + virtualID); }); ``` ### getDistributedVirtualDeviceId getDistributedVirtualDeviceId(): Promise<string> Obtains the ID of this distributed virtual device. This API uses a promise to return the result. **Required permissions**: ohos.permission.DISTRIBUTED_DATASYNC or ohos.permission.MANAGE_LOCAL_ACCOUNTS **System capability**: SystemCapability.Account.OsAccount **Return value** | Type | Description | | :-------------------- | :----------------------------------------------------------- | | Promise<string> | Promise used to return the device ID obtained.| **Example** ```js const accountManager = account_osAccount.getAccountManager(); accountManager.getDistributedVirtualDeviceId().then((virtualID) => { console.log('getDistributedVirtualDeviceId, virtualID: ' + virtualID); }).catch((err) => { console.log("getDistributedVirtualDeviceId err: " + JSON.stringify(err)); }); ``` ### getOsAccountProfilePhoto getOsAccountProfilePhoto(localId: number, callback: AsyncCallback<string>): void Obtains the profile photo of an OS account. This API uses an asynchronous callback to return the result. This is a system API and cannot be called by third-party applications. **Required permissions**: ohos.permission.MANAGE_LOCAL_ACCOUNTS **System capability**: SystemCapability.Account.OsAccount **Parameters** | Name | Type | Mandatory| Description | | -------- | --------------------------- | ---- | ---------------------------------------- | | localId | number | Yes | ID of the target OS account. | | callback | AsyncCallback<string> | Yes | Callback used to return the profile photo obtained.| **Example**: Obtain the profile photo of OS account 100. ```js const accountManager = account_osAccount.getAccountManager(); var localId = 100; accountManager.getOsAccountProfilePhoto(localId, (err, photo)=>{ console.log("getOsAccountProfilePhoto err:" + JSON.stringify(err)); console.log("get photo:" + photo + " by localId: " + localId); }); ``` ### getOsAccountProfilePhoto getOsAccountProfilePhoto(localId: number): Promise<string> Obtains the profile photo of an OS account. This API uses a promise to return the result. This is a system API and cannot be called by third-party applications. **Required permissions**: ohos.permission.MANAGE_LOCAL_ACCOUNTS **System capability**: SystemCapability.Account.OsAccount **Parameters** | Name | Type | Mandatory| Description | | ------- | ------ | ---- | ------------ | | localId | number | Yes | ID of the target OS account.| **Return value** | Type | Description | | :-------------------- | :----------------------------------------------------------- | | Promise<string> | Promise used to return the profile photo obtained.| **Example**: Obtain the profile photo of OS account 100. ```js const accountManager = account_osAccount.getAccountManager(); var localId = 100; accountManager.getOsAccountProfilePhoto(localId).then((photo) => { console.log("getOsAccountProfilePhoto: " + photo); }).catch((err) => { console.log("getOsAccountProfilePhoto err: " + JSON.stringify(err)); }); ``` ### setOsAccountProfilePhoto setOsAccountProfilePhoto(localId: number, photo: string, callback: AsyncCallback<void>): void Sets a profile photo for an OS account. This API uses an asynchronous callback to return the result. This is a system API and cannot be called by third-party applications. **Required permissions**: ohos.permission.MANAGE_LOCAL_ACCOUNTS **System capability**: SystemCapability.Account.OsAccount **Parameters** | Name | Type | Mandatory| Description | | -------- | ------------------------- | ---- | ------------ | | localId | number | Yes | ID of the target OS account.| | photo | string | Yes | Profile photo information. | | callback | AsyncCallback<void> | Yes | Callback used to return the result. | **Example**: Set a profile photo for OS account 100. ```js const accountManager = account_osAccount.getAccountManager(); var localId = 100; var photo = "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAA0AAAAPCAYAAAA/I0V3AAAAAXNSR0IArs4c6QAAAARnQU1BAA"+ "Cxjwv8YQUAAAAJcEhZcwAADsMAAA7DAcdvqGQAAACwSURBVDhPvZLBDYMwDEV/ugsXRjAT0EHCOuFIBwkbdIRewi6unbiAyoGgSn1SFH85+Y"+ "q/4ljARW62X+LHS8uIzjm4dXUYF+utzBikB52Jo5e5iEPKqpACk7R9NM2RvWm5tIkD2czLCUFNKLD6IjdMHFHDzws285MgGrT0xCtp3WOKHo"+ "+7q0mP0DZW9pNmoEFUzrQjp5cCnaen2kSJXLFD8ghbXyZCMQf/8e8Ns1XVAG/XAgqKzVnJFAAAAABJRU5ErkJggg==" accountManager.setOsAccountProfilePhoto(localId, photo, (err)=>{ console.log("setOsAccountProfilePhoto err:" + JSON.stringify(err)); }); ``` ### setOsAccountProfilePhoto setOsAccountProfilePhoto(localId: number, photo: string): Promise<void> Sets a profile photo for an OS account. This API uses a promise to return the result. This is a system API and cannot be called by third-party applications. **Required permissions**: ohos.permission.MANAGE_LOCAL_ACCOUNTS **System capability**: SystemCapability.Account.OsAccount **Parameters** | Name | Type | Mandatory| Description | | ------- | ------ | ---- | ------------ | | localId | number | Yes | ID of the target OS account.| | photo | string | Yes | Profile photo information. | **Return value** | Type | Description | | :------------------ | :---------------------------------- | | Promise<void> | Promise used to return the result.| **Example**: Set a profile photo for OS account 100. ```js const accountManager = account_osAccount.getAccountManager(); var localId = 100; var photo = "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAA0AAAAPCAYAAAA/I0V3AAAAAXNSR0IArs4c6QAAAARnQU1BAA"+ "Cxjwv8YQUAAAAJcEhZcwAADsMAAA7DAcdvqGQAAACwSURBVDhPvZLBDYMwDEV/ugsXRjAT0EHCOuFIBwkbdIRewi6unbiAyoGgSn1SFH85+Y"+ "q/4ljARW62X+LHS8uIzjm4dXUYF+utzBikB52Jo5e5iEPKqpACk7R9NM2RvWm5tIkD2czLCUFNKLD6IjdMHFHDzws285MgGrT0xCtp3WOKHo"+ "+7q0mP0DZW9pNmoEFUzrQjp5cCnaen2kSJXLFD8ghbXyZCMQf/8e8Ns1XVAG/XAgqKzVnJFAAAAABJRU5ErkJggg==" accountManager.setOsAccountProfilePhoto(localId, photo).then(() => { console.log("setOsAccountProfilePhoto success"); }).catch((err) => { console.log("setOsAccountProfilePhoto err: " + JSON.stringify(err)); }); ``` ### getOsAccountLocalIdBySerialNumber8+ getOsAccountLocalIdBySerialNumber(serialNumber: number, callback: AsyncCallback<number>): void Obtains the OS account ID based on the SN. This API uses an asynchronous callback to return the result. **System capability**: SystemCapability.Account.OsAccount **Parameters** | Name | Type | Mandatory| Description | | ------------ | --------------------------- | ---- | ------------------------------------------------ | | serialNumber | number | Yes | Account SN. | | callback | AsyncCallback<number> | Yes | Callback used to return the OS account ID obtained.| **Example**: Obtain the ID of the OS account whose SN is **12345**. ```js const accountManager = account_osAccount.getAccountManager(); var serialNumber = 12345; accountManager.getOsAccountLocalIdBySerialNumber(serialNumber, (err, localId)=>{ console.log("ger localId err:" + JSON.stringify(err)); console.log("get localId:" + localId + " by serialNumber: " + serialNumber); }); ``` ### getOsAccountLocalIdBySerialNumber8+ getOsAccountLocalIdBySerialNumber(serialNumber: number): Promise<number> Obtains the OS account ID based on the SN. This API uses a promise to return the result. **System capability**: SystemCapability.Account.OsAccount **Parameters** | Name | Type | Mandatory| Description | | ------------ | ------ | ---- | ---------- | | serialNumber | number | Yes | Account SN.| **Return value** | Type | Description | | :-------------------- | :----------------------------------------------------------- | | Promise<number> | Promise used to return the OS account ID obtained.| **Example**: Obtain the ID of the OS account whose SN is **12345**. ```js const accountManager = account_osAccount.getAccountManager(); var serialNumber = 12345; accountManager.getOsAccountLocalIdBySerialNumber(serialNumber).then((localId) => { console.log("getOsAccountLocalIdBySerialNumber localId: " + localId); }).catch((err) => { console.log("getOsAccountLocalIdBySerialNumber err: " + JSON.stringify(err)); }); ``` ### getSerialNumberByOsAccountLocalId8+ getSerialNumberByOsAccountLocalId(localId: number, callback: AsyncCallback<number>): void Obtains the SN of an OS account based on the account ID. This API uses an asynchronous callback to return the result. **System capability**: SystemCapability.Account.OsAccount **Parameters** | Name | Type | Mandatory| Description | | -------- | --------------------------- | ---- | ------------------------------------------ | | localId | number | Yes | ID of the target OS account. | | callback | AsyncCallback<number> | Yes | Callback used to return the account SN obtained.| **Example**: Obtain the SN of OS account 100. ```js const accountManager = account_osAccount.getAccountManager(); var localId = 100; accountManager.getSerialNumberByOsAccountLocalId(localId, (err, serialNumber)=>{ console.log("ger serialNumber err:" + JSON.stringify(err)); console.log("get serialNumber:" + serialNumber + " by localId: " + localId); }); ``` ### getSerialNumberByOsAccountLocalId8+ getSerialNumberByOsAccountLocalId(localId: number): Promise<number> Obtains the SN of an OS account based on the account ID. This API uses a promise to return the result. **System capability**: SystemCapability.Account.OsAccount **Parameters** | Name | Type | Mandatory| Description | | ------- | ------ | ---- | ------------ | | localId | number | Yes | ID of the target OS account.| **Return value** | Type | Description | | :-------------------- | :----------------------------------------------------------- | | Promise<number> | Promise used to return the account SN obtained.| **Example**: Obtain the SN of OS account 100. ```js const accountManager = account_osAccount.getAccountManager(); var localId = 100; accountManager.getSerialNumberByOsAccountLocalId(localId).then((serialNumber) => { console.log("getSerialNumberByOsAccountLocalId serialNumber: " + serialNumber); }).catch((err) => { console.log("getSerialNumberByOsAccountLocalId err: " + JSON.stringify(err)); }); ``` ### on on(type: 'activate' | 'activating', name: string, callback: Callback<number>): void Subscribes to OS account changes. This API uses an asynchronous callback to return the result. This is a system API and cannot be called by third-party applications. **Required permissions**: ohos.permission.INTERACT_ACROSS_LOCAL_ACCOUNTS_EXTENSION **System capability**: SystemCapability.Account.OsAccount **Parameters** | Name | Type | Mandatory| Description | | -------- | -------------------------- | ---- | ------------------------------------------------------------ | | type | 'activate' \| 'activating' | Yes | Type of the event to subscribe to. 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. | | callback | Callback<number> | Yes | Callback used to return the OS account ID and status changes. | **Example** ```js const accountManager = account_osAccount.getAccountManager(); function onCallback(receiveLocalId){ console.log("receive localId:" + receiveLocalId); } accountManager.on("activating", "osAccountOnOffNameA", onCallback); ``` ### off off(type: 'activate' | 'activating', name: string, callback?: Callback<number>): void Unsubscribes from the OS account changes. This API uses an asynchronous callback to return the result. This is a system API and cannot be called by third-party applications. **Required permissions**: ohos.permission.INTERACT_ACROSS_LOCAL_ACCOUNTS_EXTENSION **System capability**: SystemCapability.Account.OsAccount **Parameters** | Name | Type | Mandatory| Description | | -------- | -------------------------- | ---- | ------------------------------------------------------------ | | 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 used to return the OS account changes. By default, **0** is returned. | **Example** ```js const accountManager = account_osAccount.getAccountManager(); function offCallback(){ console.log("off enter") } accountManager.off("activating", "osAccountOnOffNameA", offCallback); ``` ### getBundleIdFromUid9+ getBundleIdFromUid(uid: number, callback: AsyncCallback<number>): void; Obtains the bundle ID based on the UID. This API uses an asynchronous callback to return the result. This is a system API and cannot be called by third-party applications. **System capability**: SystemCapability.Account.OsAccount **Parameters** | Name | Type | Mandatory| Description | | -------- | -------------------------- | ---- | ------------------------------------------------------------ | | uid | number | Yes | Process UID.| | callback | AsyncCallback<number> | Yes | Callback invoked to return the bundle ID obtained. | **Example** ```js const accountManager = account_osAccount.getAccountManager(); var testUid = 1000000; accountManager.getBundleIdFromUid(testUid, (err, bundleId) => { console.info("getBundleIdFromUid errInfo:" + JSON.stringify(err)); console.info("getBundleIdFromUid bundleId:" + JSON.stringify(bundleId)); }); ``` ### getBundleIdFromUid9+ getBundleIdFromUid(uid: number): Promise<number>; Obtains the bundle ID based on the UID. This API uses a promise to return the result. This is a system API and cannot be called by third-party applications. **System capability**: SystemCapability.Account.OsAccount **Parameters** | Name | Type | Mandatory| Description | | ------- | ------ | ---- | ------------ | | uid | number | Yes | Process UID.| **Return value** | Type | Description | | :-------------------- | :----------------------------------------------------------- | | Promise<number> | Promise used to return the bundle ID obtained.| **Example** ```js const accountManager = account_osAccount.getAccountManager(); var testUid = 1000000; accountManager.getBundleIdFromUid(testUid).then((result) => { console.info("getBundleIdFromUid bundleId:" + JSON.stringify(result)); }).catch((err)=>{ console.info("getBundleIdFromUid errInfo:" + JSON.stringify(err)); }); ``` ### isMainOsAccount9+ isMainOsAccount(callback: AsyncCallback<boolean>): void; Checks whether the current process belongs to the main OS account. This API uses an asynchronous callback to return the result. This is a system API and cannot be called by third-party applications. **Required permissions**: ohos.permission.MANAGE_LOCAL_ACCOUNTS **System capability**: SystemCapability.Account.OsAccount **Parameters** | Name | Type | Mandatory| Description | | -------- | -------------------------- | ---- | ------------------------------------------------------------ | | callback | AsyncCallback<boolean> | Yes | Callback used to return the result. If the current process belongs to the main OS account, **true** will be returned. Otherwise, **false** will be returned. | **Example** ```js const accountManager = account_osAccount.getAccountManager(); accountManager.isMainOsAccount((err,result)=>{ console.info("isMainOsAccount errInfo:" + JSON.stringify(err)); console.info("isMainOsAccount result:" + JSON.stringify(result)); }); ``` ### isMainOsAccount9+ isMainOsAccount(): Promise<boolean>; Checks whether the current process belongs to the main OS account. This API uses a promise to return the result. This is a system API and cannot be called by third-party applications. **Required permissions**: ohos.permission.MANAGE_LOCAL_ACCOUNTS **System capability**: SystemCapability.Account.OsAccount **Return value** | Type | Description | | :-------------------- | :----------------------------------------------------------- | | Promise<boolean> | Promise used to return the result. If the current process belongs to the main OS account, **true** will be returned. Otherwise, **false** will be returned.| **Example** ```js const accountManager = account_osAccount.getAccountManager(); accountManager.isMainOsAccount().then((result) => { console.info("isMainOsAccount result:" + JSON.stringify(result)); }).catch((err)=>{ console.info("isMainOsAccount errInfo:" + JSON.stringify(err)); }); ``` ### queryOsAccountConstraintSourceTypes9+ queryOsAccountConstraintSourceTypes(localId: number, constraint: string, callback: AsyncCallback<Array<ConstraintSourceTypeInfo>>): void; Obtains the constraint source information of an OS account. This API uses an asynchronous callback to return the result. This is a system API and cannot be called by third-party applications. **Required permissions**: ohos.permission.MANAGE_LOCAL_ACCOUNTS **System capability**: SystemCapability.Account.OsAccount **Parameters** | Name | Type | Mandatory| Description | | -------- | -------------------------- | ---- | ------------------------------------------------------------ | | localId | number | Yes | ID of the target OS account.| | constraint | string | Yes | Name of the [constraint](#constraints) to query.| | callback | AsyncCallback<Array<[ConstraintSourceTypeInfo](#constraintsourcetypeinfo)>> | Yes | Callback invoked to return the source information about the specified [constraint](#constraints). | **Example** ```js const accountManager = account_osAccount.getAccountManager(); accountManager.queryOsAccountConstraintSourceTypes(100, "constraint.wifi",(err,sourceTypeInfos)=>{ console.info("queryOsAccountConstraintSourceType errInfo:" + JSON.stringify(err)); console.info("queryOsAccountConstraintSourceType sourceTypeInfos:" + JSON.stringify(sourceTypeInfos)); }); ``` ### queryOsAccountConstraintSourceTypes9+ queryOsAccountConstraintSourceTypes(localId: number, constraint: string): Promise<Array<ConstraintSourceTypeInfo>>; Obtains the constraint source information of an OS account. This API uses a promise to return the result. This is a system API and cannot be called by third-party applications. **Required permissions**: ohos.permission.MANAGE_LOCAL_ACCOUNTS **System capability**: SystemCapability.Account.OsAccount **Parameters** | Name | Type | Mandatory| Description | | ------- | ------ | ---- | ------------ | | localId | number | Yes | ID of the target OS account.| | constraint | string | Yes | Name of the [constraint](#constraints) to query.| **Return value** | Type | Description | | :-------------------- | :----------------------------------------------------------- | | Promise<Array<[ConstraintSourceTypeInfo](#constraintsourcetypeinfo)>> | Promise used to return the source information about the specified [constraint](#constraints).| **Example** ```js const accountManager = account_osAccount.getAccountManager(); accountManager.queryOsAccountConstraintSourceTypes(100, "constraint.wifi").then((result) => { console.info("queryOsAccountConstraintSourceType sourceTypeInfos:" + JSON.stringify(result)); }).catch((err)=>{ console.info("queryOsAccountConstraintSourceType errInfo:" + JSON.stringify(err)); }); ``` ## UserAuth8+ Provides APIs for user authentication. This is a system API and cannot be called by third-party applications. ### constructor8+ constructor() A constructor used to create an instance for user authentication. This is a system API and cannot be called by third-party applications. **System capability**: SystemCapability.Account.OsAccount **Example** ```js let userAuth = new account_osAccount.UserAuth(); ``` ### getVersion8+ getVersion(): number; Obtains version information. This is a system API and cannot be called by third-party applications. **System capability**: SystemCapability.Account.OsAccount **Return value** | Type | Description | | :----- | :----------- | | number | Version information obtained.| **Example** ```js let userAuth = new account_osAccount.UserAuth(); let version = userAuth.getVersion(); console.log("getVersion version = " + version); ``` ### getAvailableStatus8+ getAvailableStatus(authType: AuthType, authTrustLevel: AuthTrustLevel): number; Checks whether the identity authentication feature is available. This is a system API and cannot be called by third-party applications. **System capability**: SystemCapability.Account.OsAccount **Required permissions**: ohos.permission.ACCESS_USER_AUTH_INTERNAL **Parameters** | Name | Type | Mandatory| Description | | --------------- | -----------------------------------------------| ---- | ------------------------- | | authType | [AuthType](#authtype8) | Yes | Authentication credential type. | | authTrustLevel | [AuthTrustLevel](#authtrustlevel8) | Yes | Trust level of the authentication result.| **Return value** | Type | Description | | :----- | :---------------------------------------- | | number | [Result code](#resultcode8).| **Example** ```js let userAuth = new account_osAccount.UserAuth(); let authType = account_osAccount.AuthType.PIN; let authTrustLevel = account_osAccount.AuthTrustLevel.ATL1; let status = userAuth.getAvailableStatus(authType, authTrustLevel); console.log("getAvailableStatus status = " + status); ``` ### getProperty8+ getProperty(request: GetPropertyRequest, callback: AsyncCallback<ExecutorProperty>): void; Obtains the executor property based on the request. This API uses an asynchronous callback to return the result. This is a system API and cannot be called by third-party applications. **System capability**: SystemCapability.Account.OsAccount **Required permissions**: ohos.permission.ACCESS_USER_AUTH_INTERNAL **Parameters** | Name | Type | Mandatory| Description | | -------- | ----------------------------------------------------------------------- | ---- | ---------------------------------- | | request | [GetPropertyRequest](#getpropertyrequest8) | Yes | Request information, including the authentication credential type and property list.| | callback | AsyncCallback<[ExecutorProperty](#executorproperty8)> | Yes | Callback invoked to return the executor property obtained. | **Example** ```js let userAuth = new account_osAccount.UserAuth(); let keys = [ account_osAccount.GetPropertyType.AUTH_SUB_TYPE, account_osAccount.GetPropertyType.REMAIN_TIMES, account_osAccount.GetPropertyType.FREEZING_TIME ]; let request = { authType: account_osAccount.AuthType.PIN, keys: keys }; userAuth.getProperty(request, (err, result) => { console.log("getProperty err = " + JSON.stringify(err)); console.log("getProperty result = " + JSON.stringify(result)); }); ``` ### getProperty8+ getProperty(request: GetPropertyRequest): Promise<ExecutorProperty>; Obtains the executor property based on the request. This API uses a promise to return the result. This is a system API and cannot be called by third-party applications. **System capability**: SystemCapability.Account.OsAccount **Required permissions**: ohos.permission.ACCESS_USER_AUTH_INTERNAL **Parameters** | Name | Type | Mandatory| Description | | -------- | ------------------------------------------------------ | ---- | ---------------------------------- | | request | [GetPropertyRequest](#getpropertyrequest8) | Yes | Request information, including the authentication credential type and property list.| **Return value** | Type | Description | | :---------------------------------------------------------------- | :-------------------------------------------------- | | Promise<[ExecutorProperty](#executorproperty8)> | Promise used to return the executor property obtained.| **Example** ```js let userAuth = new account_osAccount.UserAuth(); let keys = [ account_osAccount.GetPropertyType.AUTH_SUB_TYPE, account_osAccount.GetPropertyType.REMAIN_TIMES, account_osAccount.GetPropertyType.FREEZING_TIME ]; let request = { authType: account_osAccount.AuthType.PIN, keys: keys }; userAuth.getProperty(request).then((result) => { console.log("getProperty result = " + JSON.stringify(result)); }).catch((err) => { console.log("getProperty error = " + JSON.stringify(err)); }); ``` ### setProperty8+ setProperty(request: SetPropertyRequest, callback: AsyncCallback<number>): void; Sets the property for the initialization algorithm. This API uses an asynchronous callback to return the result. This is a system API and cannot be called by third-party applications. **System capability**: SystemCapability.Account.OsAccount **Required permissions**: ohos.permission.ACCESS_USER_AUTH_INTERNAL **Parameters** | Name | Type | Mandatory| Description | | -------- | ----------------------------------------------------- | ---- | ---------------------------------------------------------------------- | | request | [SetPropertyRequest](#setpropertyrequest8)| Yes | Request information, including the authentication credential type and key value to set. | | callback | AsyncCallback<number> | Yes | Callback invoked to return the [result](#resultcode8).| **Example** ```js let userAuth = new account_osAccount.UserAuth(); let request = { authType: account_osAccount.AuthType.PIN, key: account_osAccount.SetPropertyType.INIT_ALGORITHM, setInfo: new Uint8Array([0]) }; userAuth.setProperty(request, (err, result) => { console.log("setProperty error = " + JSON.stringify(err)); console.log("setProperty result = " + JSON.stringify(result)); }); ``` ### setProperty8+ setProperty(request: SetPropertyRequest): Promise<number>; Sets the property for the initialization algorithm. This API uses a promise to return the result. This is a system API and cannot be called by third-party applications. **System capability**: SystemCapability.Account.OsAccount **Required permissions**: ohos.permission.ACCESS_USER_AUTH_INTERNAL **Parameters** | Name | Type | Mandatory| Description | | -------- | ------------------------------------------------------ | ---- | ---------------------------------------- | | request | [SetPropertyRequest](#setpropertyrequest8) | Yes | Request information, including the authentication credential type and the key value to set.| **Return value** | Type | Description | | :-------------------- | :-------------------------------------------------------------------------------------------- | | Promise<number> | Promise used to return the [result](#resultcode8).| **Example** ```js let userAuth = new account_osAccount.UserAuth(); let request = { authType: account_osAccount.AuthType.PIN, key: account_osAccount.SetPropertyType.INIT_ALGORITHM, setInfo: new Uint8Array([0]) }; userAuth.setProperty(request).then((result) => { console.log("setProperty result = " + JSON.stringify(result)); }).catch((err) => { console.log("setProperty error = " + JSON.stringify(err)); }); ``` ### auth8+ auth(challenge: Uint8Array, authType: AuthType, authTrustLevel: AuthTrustLevel, callback: IUserAuthCallback): Uint8Array; Performs authentication. This API uses a callback to return the result. This is a system API and cannot be called by third-party applications. **System capability**: SystemCapability.Account.OsAccount **Required permissions**: ohos.permission.ACCESS_USER_AUTH_INTERNAL **Parameters** | Name | Type | Mandatory| Description | | --------------- | ---------------------------------------------------- | --- | ------------------------------------ | | challenge | Uint8Array | Yes | Challenge value, which is a random number used to improve security.| | authType | [AuthType](#authtype8) | Yes | Authentication credential type. | | authTrustLevel | [AuthTrustLevel](#authtrustlevel8) | Yes | Trust level of the authentication result. | | callback | [IUserAuthCallback](#iuserauthcallback8) | Yes | Callback invoked to return the authentication result and obtained information. | **Return value** | Type | Description | | :--------- | :----------------- | | Uint8Array | ID of the context for canceling the authentication.| **Example** ```js let userAuth = new account_osAccount.UserAuth(); let challenge = new Uint8Array([0]); let authType = account_osAccount.AuthType.PIN; let authTrustLevel = account_osAccount.AuthTrustLevel.ATL1; userAuth.auth(challenge, authType, authTrustLevel, { onResult: function(result,extraInfo){ console.log("auth result = " + result); console.log("auth extraInfo = " + JSON.stringify(extraInfo)); } }); ``` ### authUser8+ authUser(userId: number, challenge: Uint8Array, authType: AuthType, authTrustLevel: AuthTrustLevel, callback: IUserAuthCallback): Uint8Array; Perform user authentication. This API uses a callback to return the result. This is a system API and cannot be called by third-party applications. **System capability**: SystemCapability.Account.OsAccount **Required permissions**: ohos.permission.ACCESS_USER_AUTH_INTERNAL **Parameters** | Name | Type | Mandatory| Description | | --------------- | ---------------------------------------------------- | --- | ------------------------------------ | | userId | number | Yes | User ID. | | challenge | Uint8Array | Yes | Challenge value, which is a random number used to improve security. | | authType | [AuthType](#authtype8) | Yes | Authentication credential type. | | authTrustLevel | [AuthTrustLevel](#authtrustlevel8) | Yes | Trust level of the authentication result. | | callback | [IUserAuthCallback](#iuserauthcallback8) | Yes | Callback invoked to return the authentication result and obtained information. | **Return value** | Type | Description | | :--------- | :----------------- | | Uint8Array | ID of the context for canceling the authentication.| **Example** ```js let userAuth = new account_osAccount.UserAuth(); let userID = 100; let challenge = new Uint8Array([0]); let authType = account_osAccount.AuthType.PIN; let authTrustLevel = account_osAccount.AuthTrustLevel.ATL1; userAuth.authUser(userID, challenge, authType, authTrustLevel, { onResult: function(result,extraInfo){ console.log("authUser result = " + result); console.log("authUser extraInfo = " + JSON.stringify(extraInfo)); } }); ``` ### cancelAuth8+ cancelAuth(contextID: Uint8Array): number; Cancels authentication. This is a system API and cannot be called by third-party applications. **System capability**: SystemCapability.Account.OsAccount **Required permissions**: ohos.permission.ACCESS_USER_AUTH_INTERNAL **Parameters** | Name | Type | Mandatory | Description | | ----------| ---------- | ---- | ------------------------------------------ | | contextID | Uint8Array | Yes | ID of the authentication context. The context ID is dynamically generated.| **Return value** | Type | Description | | :----- | :-------------------------------------------------------- | | number | [Result code](#resultcode8).| **Example** ```js let userAuth = new account_osAccount.UserAuth(); let pinAuth = new account_osAccount.PINAuth(); let challenge = new Uint8Array([0]); let contextID = userAuth.auth(challenge, account_osAccount.AuthType.PIN, account_osAccount.AuthTrustLevel.ATL1, { onResult: (result, extraInfo) => { console.log("auth result = " + result); console.log("auth extraInfo = " + JSON.stringify(extraInfo)); } }); let result = userAuth.cancelAuth(contextID); console.log("cancelAuth result = " + result); ``` ## PINAuth8+ Provides APIs for PIN authentication. This is a system API and cannot be called by third-party applications. ### constructor8+ constructor() A constructor used to create an instance for PIN authentication. This is a system API and cannot be called by third-party applications. **System capability**: SystemCapability.Account.OsAccount **Example** ```js let pinAuth = new account_osAccount.PINAuth(); ``` ### registerInputer registerInputer(inputer: IInputer): boolean; Registers an inputer. This is a system API and cannot be called by third-party applications. **System capability**: SystemCapability.Account.OsAccount **Required permissions**: ohos.permission.ACCESS_PIN_AUTH **Parameters** | Name | Type | Mandatory| Description | | ----------| ----------------------------------- | --- | ------------------ | | inputer | [IInputer](#iinputer8) | Yes | Callback invoked to obtain the PIN.| **Return value** | Type | Description | | :------ | :-------------------------------------------- | | boolean | Returns **true** if the operation is successful; returns **false** otherwise.| **Example** ```js let pinAuth = new account_osAccount.PINAuth(); let password = new Uint8Array([0, 0, 0, 0, 0]); let result = pinAuth.registerInputer({ onGetData: (pinSubType, callback) => { callback.onSetData(pinSubType, password); } }); console.log("registerInputer result = " + result); ``` ### unregisterInputer unregisterInputer(): void; Unregisters the inputer. This is a system API and cannot be called by third-party applications. **System capability**: SystemCapability.Account.OsAccount **Required permissions**: ohos.permission.ACCESS_PIN_AUTH **Example** ```js let pinAuth = new account_osAccount.PINAuth(); pinAuth.unregisterInputer(); ``` ## UserIdentityManager8+ Provides APIs for user identity management. This is a system API and cannot be called by third-party applications. ### constructor8+ constructor() A constructor used to create an instance for user authentication. This is a system API and cannot be called by third-party applications. **System capability**: SystemCapability.Account.OsAccount **Example** ```js let userIDM = new account_osAccount.UserIdentityManager(); ``` ### openSession8+ openSession(callback: AsyncCallback<Uint8Array>): void; Opens a session to start identity management (IDM) so that a challenge value can be obtained. This API uses an asynchronous callback to return the result. This is a system API and cannot be called by third-party applications. **System capability**: SystemCapability.Account.OsAccount **Required permissions**: ohos.permission.MANAGE_USER_IDM **Parameters** | Name | Type | Mandatory| Description | | -------- | -------------------------------- | ---- | -------------------------------- | | callback | AsyncCallback<Uint8Array> | Yes | Callback invoked to return the challenge value. If **0** is returned, the operation failed.| **Example** ```js let userIDM = new account_osAccount.UserIdentityManager(); userIDM.openSession((err, challenge) => { console.log("openSession error = " + JSON.stringify(err)); console.log("openSession challenge = " + JSON.stringify(challenge)); }); ``` ### openSession8+ openSession(): Promise<Uint8Array>; Opens a session to start IDM so that a challenge value can be obtained. This API uses a promise to return the result. This is a system API and cannot be called by third-party applications. **System capability**: SystemCapability.Account.OsAccount **Required permissions**: ohos.permission.MANAGE_USER_IDM **Return value** | Type | Description | | :------------------------ | :------------------------------------------------------- | | Promise<Uint8Array> | Promise used to return the challenge value. If **0** is returned, the operation failed.| **Example** ```js let userIDM = new account_osAccount.UserIdentityManager(); userIDM.openSession().then((challenge) => { console.info("openSession challenge = " + JSON.stringify(challenge)); }).catch((err) => { console.info("openSession error = " + JSON.stringify(err)); }); ``` ### addCredential8+ addCredential(credentialInfo: CredentialInfo, callback: IIdmCallback): void; Adds credential information, which includes the authentication credential type, subtype, and token (if a non-PIN credential is added). This API uses a callback to return the result. This is a system API and cannot be called by third-party applications. **System capability**: SystemCapability.Account.OsAccount **Required permissions**: ohos.permission.MANAGE_USER_IDM **Parameters** | Name | Type | Mandatory| Description | | --------------- | ------------------------------------------------ | --- | -------------------------------- | | credentialInfo | [CredentialInfo](#credentialinfo8) | Yes | Credential information to add. | | callback | [IIdmCallback](#iidmcallback8) | Yes | Callback invoked to return the result and obtained information. | **Example** ```js let password = new Uint8Array([0, 0, 0, 0, 0, 0]); let pinAuth = new account_osAccount.PINAuth(); pinAuth.registerInputer({ onGetData: (pinSubType, callback) => { callback.onSetData(pinSubType, password); } }); let credentialInfo = { credType: account_osAccount.AuthType.PIN, credSubType: account_osAccount.AuthSubType.PIN_SIX, token: null }; let userIDM = new account_osAccount.UserIdentityManager(); userIDM.openSession((err, challenge) => { userIDM.addCredential(credentialInfo, { onResult: (result, extraInfo) => { console.log("updateCredential result = " + result); console.log("updateCredential extraInfo = " + extraInfo); } }); }); ``` ### updateCredential8+ updateCredential(credentialInfo: CredentialInfo, callback: IIdmCallback): void; Updates credential information. This API uses a callback to return the result. This is a system API and cannot be called by third-party applications. **System capability**: SystemCapability.Account.OsAccount **Required permissions**: ohos.permission.MANAGE_USER_IDM **Parameters** | Name | Type | Mandatory| Description | | --------------- | ------------------------------------------------- | --- | -------------------------------- | | credentialInfo | [CredentialInfo](#credentialinfo8) | Yes | New credential information. | | callback | [IIdmCallback](#iidmcallback8) | Yes | Callback invoked to return the result and obtained information. | **Example** ```js let userIDM = new account_osAccount.UserIdentityManager(); let userAuth = new account_osAccount.UserAuth(); let pinAuth = new account_osAccount.PINAuth(); let password = new Uint8Array([0, 0, 0, 0, 0, 0]); let credentialInfo = { credType: account_osAccount.AuthType.PIN, credSubType: account_osAccount.AuthSubType.PIN_SIX, token: null }; pinAuth.registerInputer({ onGetData: (pinSubType, callback) => { callback.onSetData(pinSubType, password); } }); userIDM.openSession((err, challenge) => { userAuth.auth(challenge, credentialInfo.credType, account_osAccount.AuthTrustLevel.ATL1, { onResult: (result, extraInfo) => { if (result != account_osAccount.ResultCode.SUCCESS) { return; } credentialInfo.token = extraInfo.token; userIDM.updateCredential(credentialInfo, { onResult: (result, extraInfo) => { console.log("updateCredential result = " + result); console.log("updateCredential extraInfo = " + extraInfo); } }); } }); }); ``` ### closeSession8+ closeSession(): void; Closes this session to terminate IDM. This is a system API and cannot be called by third-party applications. **System capability**: SystemCapability.Account.OsAccount **Required permissions**: ohos.permission.MANAGE_USER_IDM **Example** ```js let userIDM = new account_osAccount.UserIdentityManager(); userIDM.closeSession(); ``` ### cancel8+ cancel(challenge: Uint8Array): number; Cancels an entry based on the challenge value. This is a system API and cannot be called by third-party applications. **System capability**: SystemCapability.Account.OsAccount **Required permissions**: ohos.permission.MANAGE_USER_IDM **Parameters** | Name | Type | Mandatory| Description | | -------- | ----------- | ---- | ----- | | challenge | Uint8Array | Yes | Challenge value.| **Return value** | Type | Description | | :----- | :-------------------------------------------------------- | | number | [Result code](#resultcode8) indicating whether the operation is successful.| **Example** ```js let userIDM = new account_osAccount.UserIdentityManager(); let challenge = new Uint8Array([0]); let result = userIDM.cancel(challenge); console.log("cancel result: " + result); ``` ### delUser8+ delUser(token: Uint8Array, callback: IIdmCallback): void; Deletes a user based on the authentication token. The API uses a callback to return the result. This is a system API and cannot be called by third-party applications. **System capability**: SystemCapability.Account.OsAccount **Required permissions**: ohos.permission.MANAGE_USER_IDM **Parameters** | Name | Type | Mandatory| Description | | -------- | ------------------------------------------ | --- | ------------------------- | | token | Uint8Array | Yes | Authentication token. | | callback | [IIdmCallback](#iidmcallback8) | Yes | Callback invoked to return the result.| **Example** ```js let userIDM = new account_osAccount.UserIdentityManager(); let token = new Uint8Array([0]); userIDM.delUser(token, { onResult: (result, extraInfo) => { console.log("delUser result = " + result); console.log("delUser extraInfo = " + JSON.stringify(extraInfo)); } }); ``` ### delCred8+ delCred(credentialId: Uint8Array, token: Uint8Array, callback: IIdmCallback): void; Deletes user credential information. The API uses a callback to return the result. This is a system API and cannot be called by third-party applications. **System capability**: SystemCapability.Account.OsAccount **Required permissions**: ohos.permission.MANAGE_USER_IDM **Parameters** | Name | Type | Mandatory| Description | | --------------- | ----------------------------------------------- | --- | ---------------------------| | credentialId | Uint8Array | Yes | Credential ID. | | token | Uint8Array | Yes | Authentication token. | | callback | [IIdmCallback](#iidmcallback8) | Yes | Callback invoked to return the result.| **Example** ```js let userIDM = new account_osAccount.UserIdentityManager(); let credentialId = new Uint8Array([0]); let token = new Uint8Array([0]); userIDM.delCred(credentialId, token, { onResult: (result, extraInfo) => { console.log("delCred result = " + result); console.log("delCred extraInfo = " + JSON.stringify(extraInfo)); } }); ``` ### getAuthInfo8+ getAuthInfo(callback: AsyncCallback<Array<EnrolledCredInfo>>): void; Obtains authentication information. This API uses asynchronous callback to return the result. This is a system API and cannot be called by third-party applications. **System capability**: SystemCapability.Account.OsAccount **Required permissions**: ohos.permission.USE_USER_IDM **Parameters** | Name | Type | Mandatory| Description | | -------- | -------------------------------------------------- | ---- | -------------------------------------------------- | | callback | AsyncCallback<Array<[EnrolledCredInfo](#enrolledcredinfo8)>> | Yes | Callback invoked to return information about all enrolled credentials of the specified type.| **Example** ```js let userIDM = new account_osAccount.UserIdentityManager(); userIDM.getAuthInfo((err, result) => { console.log("getAuthInfo err = " + JSON.stringify(err)); console.log("getAuthInfo result = " + JSON.stringify(result)); }); ``` ### getAuthInfo8+ getAuthInfo(authType: AuthType, callback: AsyncCallback<Array<EnrolledCredInfo>>): void; Obtains authentication information of the specified type. This API uses an asynchronous callback to return the result. This is a system API and cannot be called by third-party applications. **System capability**: SystemCapability.Account.OsAccount **Required permissions**: ohos.permission.USE_USER_IDM **Parameters** | Name | Type | Mandatory| Description | | -------- | -------------------------------------------------- | ---- | -------------------------------------------------- | | authType | [AuthType](#authtype8) | Yes | Authentication credential type. | | callback | AsyncCallback<Array<[EnrolledCredInfo](#enrolledcredinfo8)>> | Yes | Callback invoked to return information about all the user's enrolled credentials of the specified type.| **Example** ```js let userIDM = new account_osAccount.UserIdentityManager(); userIDM.getAuthInfo(account_osAccount.AuthType.PIN, (err, result) => { console.log("getAuthInfo err = " + JSON.stringify(err)); console.log("getAuthInfo result = " + JSON.stringify(result)); }); ``` ### getAuthInfo8+ getAuthInfo(authType?: AuthType): Promise<Array<EnrolledCredInfo>>; Obtains authentication information. This API uses a promise to return the result. This is a system API and cannot be called by third-party applications. **System capability**: SystemCapability.Account.OsAccount **Required permissions**: ohos.permission.USE_USER_IDM **Parameters** | Name | Type | Mandatory| Description | | -------- | ----------------------------------- | ---- | -------- | | authType | [AuthType](#authtype8) | No | Authentication credential type.| **Return value** | Type | Description | | :------------------------------------------- | :------------------------------------------------------------------------ | | Promise<Array<[EnrolledCredInfo](#enrolledcredinfo8)>> | Promise used to return information about all the user's enrolled credentials of the specified type.| **Example** ```js let userIDM = new account_osAccount.UserIdentityManager(); userIDM.getAuthInfo(account_osAccount.AuthType.PIN).then((result) => { console.log("getAuthInfo result = " + JSON.stringify(result)) }).catch((err) => { console.log("getAuthInfo error = " + JSON.stringify(err)); }); ``` ## IInputData8+ Provides callbacks for PIN operations. This is a system API and cannot be called by third-party applications. ### onSetData8+ onSetData: (pinSubType: AuthSubType, data: Uint8Array) => void; This is a system API and cannot be called by third-party applications. Called to set data. **System capability**: SystemCapability.Account.OsAccount **Parameters** | Name | Type | Mandatory| Description | | ---------- | ---------------------------------------- | ---- | ----------------------------------------------- | | pinSubType | [AuthSubType](#authsubtype8) | Yes | Credential subtype. | | data | Uint8Array | Yes | Data (credential) to set. The data is used for authentication and operations for adding and modifying credentials.| **Example** ```js let password = new Uint8Array([0, 0, 0, 0, 0, 0]); let passwordNumber = new Uint8Array([1, 2, 3, 4]); let inputer = { onGetData: (pinSubType, callback) => { if (pinSubType == account_osAccount.AuthSubType.PIN_NUMBER) { callback.onSetData(pinSubType, passwordNumber); } else { callback.onSetData(pinSubType, password); } } }; ``` ## IInputer8+ Provides callbacks for the PIN input box. This is a system API and cannot be called by third-party applications. ### onGetData8+ onGetData: (pinSubType: AuthSubType, callback: IInputData) => void; Called to obtain data. This is a system API and cannot be called by third-party applications. **System capability**: SystemCapability.Account.OsAccount **Parameters** | Name | Type | Mandatory| Description | | ---------- | --------------------------------------- | ---- | --------------- | | callback | [IInputData](#iinputdata8) | Yes | Called to input the PIN.| **Example** ```js let password = new Uint8Array([0, 0, 0, 0, 0, 0]); let passwordNumber = new Uint8Array([1, 2, 3, 4]); let inputer = { onGetData: (pinSubType, callback) => { if (pinSubType == account_osAccount.AuthSubType.PIN_NUMBER) { callback.onSetData(pinSubType, passwordNumber); } else { callback.onSetData(pinSubType, password); } } }; let pinAuth = new account_osAccount.PINAuth(); let result = pinAuth.registerInputer(inputer); console.log("registerInputer result: " + result); ``` ## IUserAuthCallback8+ Provides callbacks for user authentication. This is a system API and cannot be called by third-party applications. ### onResult8+ onResult: (result: number, extraInfo: AuthResult) => void; Called to return the authentication result code. This is a system API and cannot be called by third-party applications. **System capability**: SystemCapability.Account.OsAccount **Parameters** | Name | Type | Mandatory| Description | | --------- | --------------------------------------- | ---- | ------------------- | | result | number | Yes | Authentication result code.| | extraInfo | [AuthResult](#authresult8) | Yes | Specific authentication result information. If the authentication is successful, the authentication token is returned in **extrainfo**. If the authentication fails, the remaining authentication time is returned. If the authentication executor is locked, the freezing time is returned.| **Example** ```js let authCallback = { onResult: (result, extraInfo) => { console.log("auth result = " + result); console.log("auth extraInfo = " + JSON.stringify(extraInfo)); } }; ``` ### onAcquireInfo?8+ onAcquireInfo?: (module: number, acquire: number, extraInfo: any) => void; Called to return the **TipsCode** during the authentication process. This is a system API and cannot be called by third-party applications. **System capability**: SystemCapability.Account.OsAccount **Parameters** | Name | Type | Mandatory| Description | | --------- | ------- | ---- | ----------------------------- | | module | number | Yes | Type of authentication executor. | | acquire | number | Yes | Tip code of the authentication executor.| | extraInfo | any | Yes | Reserved. | **Example** ```js let authCallback = { onResult: (result, extraInfo) => { console.log("auth result = " + result) console.log("auth extraInfo = " + JSON.stringify(extraInfo)); }, onAcquireInfo: (module, acquire, extraInfo) => { console.log("auth module = " + module); console.log("auth acquire = " + acquire); console.info('auth extraInfo = ' + JSON.stringify(extraInfo)); } }; ``` ## IIdmCallback8+ Provides callbacks for IDM. This is a system API and cannot be called by third-party applications. ### onResult8+ onResult: (result: number, extraInfo: RequestResult) => void; Called to return the authentication result code. This is a system API and cannot be called by third-party applications. **System capability**: SystemCapability.Account.OsAccount **Parameters** | Name | Type | Mandatory| Description | | --------- | --------------------------------------- | ---- | ----------------------- | | result | number | Yes | Authentication result code. | | extraInfo | [AuthResult](#authresult8) | Yes | Specific information to be transferred.| **Example** ```js var idmCallback = { onResult: (result, extraInfo) => { console.log("callback result = " + result) console.info('callback extraInfo = ' + JSON.stringify(extraInfo)); } }; ``` ### onAcquireInfo?8+ onAcquireInfo?: (module: number, acquire: number, extraInfo: any) => void; Called to return the **TipsCode** during the authentication process. This is a system API and cannot be called by third-party applications. **System capability**: SystemCapability.Account.OsAccount **Parameters** | Name | Type | Mandatory| Description | | --------- | ------- | ---- | ----------------------------- | | module | number | Yes | Type of authentication executor. | | acquire | number | Yes | Tip code of the authentication executor.| | extraInfo | any | Yes | Reserved. | **Example** ```js let idmCallback = { onResult: (result, extraInfo) => { console.log("callback result = " + result) console.log("callback onResult = " + JSON.stringify(extraInfo)); }, onAcquireInfo: (module, acquire, extraInfo) => { console.log("callback module = " + module); console.log("callback acquire = " + acquire); console.log('callback onacquireinfo = ' + JSON.stringify(extraInfo)); } }; ``` ## GetPropertyRequest8+ Defines the request for obtaining property information. This is a system API and cannot be called by third-party applications. **System capability**: SystemCapability.Account.OsAccount | Name | Type | Mandatory | Description | | -------- | ------------------------------------------------------------- | ----- | ----------------------- | | authType | [AuthType](#authtype8) | Yes | Authentication credential type. | | keys | Array<[GetPropertyType](#getpropertytype8)> | Yes | An array of the types of the properties to obtain.| ## SetPropertyRequest8+ Defines the request for setting property information. This is a system API and cannot be called by third-party applications. **System capability**: SystemCapability.Account.OsAccount | Name | Type | Mandatory | Description | | -------- | ------------------------------------------------ | ----- | -------------------- | | authType | [AuthType](#authtype8) | Yes | Authentication credential type. | | key | [SetPropertyType](#setpropertytype8) | Yes | Type of the property to set.| | setInfo | Uint8Array | Yes | Information to set. | ## ExecutorProperty8+ Defines the executor property. This is a system API and cannot be called by third-party applications. **System capability**: SystemCapability.Account.OsAccount | Name | Type | Mandatory | Description | | ------------ | ---------------------------------------- | ----- | ----------------- | | result | number | Yes | Result. | | authSubType | [AuthSubType](#authsubtype8) | Yes | Authentication credential subtype.| | remainTimes | number | No | Remaining time. | | freezingTime | number | No | Freezing time. | ## AuthResult8+ Defines the authentication result information. This is a system API and cannot be called by third-party applications. **System capability**: SystemCapability.Account.OsAccount | Name | Type | Mandatory | Description | | ------------ | ----------- | ----- | ----------------- | | token | Uint8Array | No | Authentication token. | | remainTimes | number | No | Remaining time. | | freezingTime | number | No | Freezing time. | ## CredentialInfo8+ Defines the credential information. This is a system API and cannot be called by third-party applications. **System capability**: SystemCapability.Account.OsAccount | Name | Type | Mandatory | Description | | ------------ | ---------------------------------------- | ----- | ----------------- | | credType | [AuthType](#authtype8) | Yes | Authentication credential type. | | credSubType | [AuthSubType](#authsubtype8) | Yes | Authentication credential subtype. | | token | Uint8Array | Yes | Authentication token. | ## RequestResult8+ Defines the request result information. This is a system API and cannot be called by third-party applications. **System capability**: SystemCapability.Account.OsAccount | Name | Type | Mandatory | Description | | ------------ | ----------- | ----- | ----------------- | | credentialId | Uint8Array | No | Credential ID. | ## EnrolledCredInfo8+ Defines enrolled credential information. This is a system API and cannot be called by third-party applications. **System capability**: SystemCapability.Account.OsAccount | Name | Type | Mandatory | Description | | ------------ | ---------------------------------------- | ----- | ------------------- | | credentialId | Uint8Array | Yes | Credential ID. | | authType | [AuthType](#authtype8) | Yes | Authentication credential type. | | authSubType | [AuthSubType](#authsubtype8) | Yes | Credential subtype.| | templateId | Uint8Array | Yes | Authentication credential template ID. | ## GetPropertyType8+ Enumerates the types of the properties to obtain. This is a system API and cannot be called by third-party applications. **System capability**: SystemCapability.Account.OsAccount | Name | Default Value| Description | | ------------- | ------ | --------- | | AUTH_SUB_TYPE | 1 | Authentication credential subtype.| | REMAIN_TIMES | 2 | Remaining time. | | FREEZING_TIME | 3 | Freezing time. | ## SetPropertyType8+ Enumerates the types of the properties to set. This is a system API and cannot be called by third-party applications. **System capability**: SystemCapability.Account.OsAccount | Name | Default Value| Description | | -------------- | ----- | ----------- | | INIT_ALGORITHM | 1 | Initialization algorithm.| ## AuthType8+ Enumerates the authentication credential types. This is a system API and cannot be called by third-party applications. **System capability**: SystemCapability.Account.OsAccount | Name | Default Value| Description | | ----- | ----- | ---------------- | | PIN | 1 | PIN authentication.| | FACE | 2 | Facial authentication.| ## AuthSubType8+ Enumerates the authentication credential subtypes. This is a system API and cannot be called by third-party applications. **System capability**: SystemCapability.Account.OsAccount | Name | Default Value| Description | | ---------- | ----- | ------------------ | | PIN_SIX | 10000 | Six-digit PIN. | | PIN_NUMBER | 10001 | Custom PIN.| | PIN_MIXED | 10002 | Custom mixed credential.| | FACE_2D | 20000 | 2D face credential. | | FACE_3D | 20001 | 3D face credential. | ## AuthTrustLevel8+ Enumerates the trust levels of the authentication result. This is a system API and cannot be called by third-party applications. **System capability**: SystemCapability.Account.OsAccount | Name | Default Value| Description | | ---- | ------ | ----------- | | ATL1 | 10000 | Trust level 1.| | ATL2 | 20000 | Trust level 2.| | ATL3 | 30000 | Trust level 3.| | ATL4 | 40000 | Trust level 4.| ## Module8+ Enumerates the modules from which information is obtained. This is a system API and cannot be called by third-party applications. **System capability**: SystemCapability.Account.OsAccount | Name | Default Value| Description | | --------- | ------ | ------------------------ | | FACE_AUTH | 1 | Face authentication module.| ## ResultCode8+ Enumerates the authentication result codes. This is a system API and cannot be called by third-party applications. **System capability**: SystemCapability.Account.OsAccount | Name | Default Value| Description | | ----------------------- | ----- | ---------------------------------------- | | SUCCESS | 0 | The authentication is successful or the authentication feature is supported. | | FAIL | 1 | The authentication executor failed to identify the user. | | GENERAL_ERROR | 2 | Other errors. | | CANCELED | 3 | The authentication is canceled. | | TIMEOUT | 4 | The authentication timed out. | | TYPE_NOT_SUPPORT | 5 | The authentication credential type is not supported. | | TRUST_LEVEL_NOT_SUPPORT | 6 | The authentication trust level is not supported. | | BUSY | 7 | The authentication executor is busy. Try again after a few seconds.| | INVALID_PARAMETERS | 8 | Incorrect parameters are detected. | | LOCKED | 9 | The authentication executor is locked. | | NOT_ENROLLED | 10 | The authentication executor is not enrolled. | ## FaceTipsCode8+ Enumerates the tip codes for facial authentication. This is a system API and cannot be called by third-party applications. **System capability**: SystemCapability.Account.OsAccount | Name | Default Value| Description | | ----------------------------- | ----- | ---------------------------------------- | | FACE_AUTH_TIP_TOO_BRIGHT | 1 | The obtained face image is too bright. | | FACE_AUTH_TIP_TOO_DARK | 2 | The obtained face image is too dark. | | 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 angled too much to the right.| | FACE_AUTH_TIP_TOO_LEFT | 8 | Only the left part of the face is captured because the device is angled too much 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 device. | | FACE_AUTH_TIP_NOT_DETECTED | 11 | No face is detected. | ## FingerprintTips8+ Enumerates the tip codes for fingerprint authentication. This is a system API and cannot be called by third-party applications. **System capability**: SystemCapability.Account.OsAccount | Name | Default Value| Description | | ----------------------------- | ----- | ----------------------------------------------- | | FINGERPRINT_TIP_GOOD | 0 | The captured image is clear. | | FINGERPRINT_TIP_IMAGER_DIRTY | 1 | The fingerprint image has big noise due to dirt on the sensor.| | FINGERPRINT_TIP_INSUFFICIENT | 2 | Failed to process the fingerprint image due to big noise. | | FINGERPRINT_TIP_PARTIAL | 3 | Only part of the fingerprint image is detected. | | FINGERPRINT_TIP_TOO_FAST | 4 | The fingerprint image is incomplete due to quick motion. | | FINGERPRINT_TIP_TOO_SLOW | 5 | Failed to read the fingerprint image due to lack of motion. | ## OsAccountInfo Defines information about an OS account. **System capability**: SystemCapability.Account.OsAccount | Name | Type | Mandatory| Description | | ------------------------------ | ------------------------------------------------------------ | ---- | --------------------------------- | | localId | number | Yes | ID of the target OS account. | | localName | string | Yes | OS account name. | | type | [OsAccountType](#osaccounttype) | Yes | OS account type. | | constraints | Array<string> | No | [Constraints](#constraints) on the OS account.| | isVerified8+ | boolean | Yes | Whether the OS account is verified. | | photo8+ | string | No | Profile photo of the OS account. | | createTime8+ | number | Yes | Time when the OS account was created. | | lastLoginTime8+ | number | No | Last login time of the OS account. | | serialNumber8+ | number | Yes | SN of the OS account. | | isActived8+ | boolean | Yes | Whether the OS account is activated. | | isCreateCompleted8+ | boolean | Yes | Whether the OS account information is complete. | | distributedInfo | [distributedAccount.DistributedInfo](js-apis-distributed-account.md) | No | Distributed account information. | | domainInfo8+ | [DomainAccountInfo](#domainaccountinfo8) | No | Domain account information. | ## DomainAccountInfo8+ Domain account information. **System capability**: SystemCapability.Account.OsAccount | Name | Type | Mandatory| Description | | ----------- | ------ | ---- | ---------- | | domain | string | Yes | Domain name. | | accountName | string | Yes | Domain account name.| ## Constraints | Constraint | Description | | ------------------------------------- | ------------------------------ | | constraint.wifi | A user is not allowed to use Wi-Fi. | | constraint.wifi.set | A user is not allowed to change Wi-Fi settings. | | constraint.locale.set | A user is not allowed to change the device language. | | constraint.app.accounts | A user is not allowed to add or delete app accounts. | | constraint.apps.install | A user is not allowed to install apps. | | constraint.apps.uninstall | A user is not allowed to uninstall apps. | | constraint.location.shared | A user is not allowed to enable location sharing. | | constraint.unknown.sources.install | A user is not allowed to install apps from unknown sources. | | constraint.global.unknown.app.install | All users are not allowed to install apps from unknown sources.| | constraint.bluetooth.set | A user is not allowed to configure Bluetooth. | | constraint.bluetooth | The use of Bluetooth is prohibited on the device.| | constraint.bluetooth.share | Bluetooth sharing is prohibited.| | constraint.usb.file.transfer | A user is not allowed to transfer files over USB.| | constraint.credentials.set | A user is not allowed to configure user credentials.| | constraint.os.account.remove | An admin user is not allowed to remove users or a non-admin user is not allowed to remove itself.| | constraint.managed.profile.remove | The managed profiles of this user cannot be removed.| | constraint.debug.features.use | A user is not allowed to enable or access debugging features.| | constraint.vpn.set | A user is not allowed to configure a VPN.| | constraint.date.time.set | A user is not allowed to set date, time, or time zone.| | constraint.tethering.config | A user is not allowed to configure Tethering.| | constraint.network.reset | A user is not allowed to reset network settings.| | constraint.factory.reset | A user is not allowed to reset factory settings.| | constraint.os.account.create | A user is not allowed to create users.| | constraint.add.managed.profile | A user is not allowed to add managed profiles.| | constraint.apps.verify.disable | A user is not allowed to disable app verification.| | constraint.cell.broadcasts.set | A user is not allowed to configure cell broadcasts.| | constraint.mobile.networks.set | A user is not allowed to configure radio networks.| | constraint.control.apps | A user is not allowed to modify apps in **Settings** or the boot module.| | constraint.physical.media | A user is not allowed to mount external physical media.| | constraint.microphone | A user is not allowed to use microphones.| | constraint.microphone.unmute | A user is not allowed to unmute the microphone.| | constraint.volume.adjust | A user is not allowed to adjust the volume.| | constraint.calls.outgoing | A user is not allowed to make outgoing calls.| | constraint.sms.use | A user is not allowed to send or receive SMS messages.| | constraint.fun | A user is not allowed to have entertainment.| | constraint.windows.create | Windows other than app windows cannot be created.| | constraint.system.error.dialogs | Error dialogs for crashed or unresponsive apps are prohibited.| | constraint.cross.profile.copy.paste | Pasting clipboard content to other users or profiles is prohibited.| | constraint.beam.outgoing | A user is not allowed to use Near Field Communications (NFC) to transfer data from apps.| | constraint.wallpaper | A user is not allowed to manage wallpapers.| | constraint.safe.boot | A user is not allowed to reboot the device in safe boot mode.| | constraint.parent.profile.app.linking | The apps in the parent profile are allowed to handle web links from the managed profile.| | constraint.audio.record | Audio recording is prohibited.| | constraint.camera.use | The use of cameras is prohibited.| | constraint.os.account.background.run | Running in the background is prohibited.| | constraint.data.roam | A user is not allowed to use cellular data when roaming.| | constraint.os.account.set.icon | A user is not allowed to change their icon.| | constraint.wallpaper.set | A user is not allowed to set a wallpaper.| | constraint.oem.unlock | A user is not allowed to enable OEM unlock.| | constraint.device.unmute | A user is not allowed to unmute the device.| | constraint.password.unified | The managed profile is not allowed to have unified lock screen challenge with the primary user.| | constraint.autofill | A user is not allowed to use the autofill service.| | constraint.content.capture | Capturing the content of a user's screen is prohibited.| | constraint.content.suggestions | A user is not allowed to receive content suggestions.| | constraint.os.account.start | User switching is blocked.| | constraint.location.set | A user is not allowed to configure the location service.| | constraint.airplane.mode.set | The airplane mode is prohibited on the device.| | constraint.brightness.set | A user is not allowed to configure brightness.| | constraint.share.into.profile | A user is not allowed to share files, images, or data from the primary user to the managed profile.| | constraint.ambient.display | Ambient display is prohibited for the user.| | constraint.screen.timeout.set | A user is not allowed to configure the screen off timeout.| | constraint.print | A user is not allowed to print.| | constraint.private.dns.set | A user is not allowed to configure a private domain name server (DNS).| ## ConstraintSourceTypeInfo9+ Defines information about the source of a constraint. This is a system API. **System capability**: SystemCapability.Account.OsAccount | Name | Type | Mandatory| Description | | ----------- | ------ | ---- | ---------- | | localId | number | Yes | ID of the OS account. | | type | [ConstraintSourceType](#constraintsourcetype) | Yes | Type of the constrain source.| ## ConstraintSourceType9+ Enumerates the constraint sources. This is a system API. **System capability**: SystemCapability.Account.OsAccount | Name | Default Value| Description | | ------ | ------ | ------------ | | CONSTRAINT_NOT_EXIST | 0 | The constraint does not exist.| | CONSTRAINT_TYPE_BASE | 1 | Constraint from system settings. | | CONSTRAINT_TYPE_DEVICE_OWNER | 2 | Constraint from the device owners' settings. | | CONSTRAINT_TYPE_PROFILE_OWNER | 3 | Constraint from the profile owners' settings. |