@ohos.account.osAccount (OS Account Management)

The osAccount module provides basic capabilities for managing OS accounts, including adding, deleting, querying, setting, subscribing to, and enabling an OS account.

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

import account_osAccount from '@ohos.account.osAccount';

account_osAccount.getAccountManager

getAccountManager(): AccountManager

Obtains an AccountManager instance.

System capability: SystemCapability.Account.OsAccount

Return value

Example

let accountManager = account_osAccount.getAccountManager();

OsAccountType

Enumerates the OS account types.

System capability: SystemCapability.Account.OsAccount

AccountManager

Provides APIs for managing OS accounts.

activateOsAccount

activateOsAccount(localId: number, callback: AsyncCallback<void>): void

Activates an OS account. This API uses an asynchronous callback to return the result.

System API: This is a system API.

Required permissions: ohos.permission.INTERACT_ACROSS_LOCAL_ACCOUNTS_EXTENSION

System capability: SystemCapability.Account.OsAccount

Parameters

Error codes

Example: Activate OS account 100.

let accountManager = account_osAccount.getAccountManager();
let localId = 100;
try {
  accountManager.activateOsAccount(localId, (err)=>{
    if (err) {
      console.log("activateOsAccount failed, error:" + JSON.stringify(err));
    } else {
      console.log("activateOsAccount successfully");
    }
  });
} catch (err) {
  console.log("activateOsAccount exception:" + JSON.stringify(err));
}

activateOsAccount

activateOsAccount(localId: number): Promise<void>

Activates an OS account. This API uses a promise to return the result.

System API: This is a system API.

Required permissions: ohos.permission.INTERACT_ACROSS_LOCAL_ACCOUNTS_EXTENSION

System capability: SystemCapability.Account.OsAccount

Parameters

Return value

Error codes

Example: Activate OS account 100.

let accountManager = account_osAccount.getAccountManager();
let localId = 100;
try {
  accountManager.activateOsAccount(localId).then(() => {
    console.log('activateOsAccount successfully');
  }).catch((err) => {
    console.log('activateOsAccount failed, err:' + JSON.stringify(err));
  });
} catch (e) {
  console.log('activateOsAccount exception:' + JSON.stringify(e));
}

checkMultiOsAccountEnabled⁹⁺

checkMultiOsAccountEnabled(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

Error codes

Example

let accountManager = account_osAccount.getAccountManager();
try {
  accountManager.checkMultiOsAccountEnabled((err, isEnabled) => {
    if (err) {
      console.log("checkMultiOsAccountEnabled failed, error: " + JSON.stringify(err));
    } else {
    console.log("checkMultiOsAccountEnabled successfully, isEnabled: " + isEnabled);
    }
  });
} catch (err) {
  console.log("checkMultiOsAccountEnabled exception: " + JSON.stringify(err));
}

checkMultiOsAccountEnabled⁹⁺

checkMultiOsAccountEnabled(): 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

Error codes

Example

try {
  let accountManager = account_osAccount.getAccountManager();
  accountManager.checkMultiOsAccountEnabled().then((isEnabled) => {
    console.log('checkMultiOsAccountEnabled successfully, isEnabled: ' + isEnabled);
  }).catch((err) => {
    console.log('checkMultiOsAccountEnabled failed, error: '  + JSON.stringify(err));
  });
} catch (err) {
  console.log('checkMultiOsAccountEnabled exception: ' + JSON.stringify(err));
}

checkOsAccountActivated⁹⁺

checkOsAccountActivated(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

Error codes

Example: Check whether OS account 100 is activated.

let accountManager = account_osAccount.getAccountManager();
let localId = 100;
try {
  accountManager.checkOsAccountActivated(localId, (err, isActivated) => {
    if (err) {
      console.log('checkOsAccountActivated failed, error:' + JSON.stringify(err));
    } else {
      console.log('checkOsAccountActivated successfully, isActivated:' + isActivated);
    }
  });
} catch (err) {
  console.log('checkOsAccountActivated exception:' + JSON.stringify(err));
}

checkOsAccountActivated⁹⁺

checkOsAccountActivated(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

Return value

Error codes

Example: Check whether OS account 100 is activated.

let accountManager = account_osAccount.getAccountManager();
let localId = 100;
try {
  accountManager.checkOsAccountActivated(localId).then((isActivated) => {
    console.log('checkOsAccountActivated successfully, isActivated: ' + isActivated);
  }).catch((err) => {
    console.log('checkOsAccountActivated failed, error: '  + JSON.stringify(err));
  });
} catch (err) {
  console.log('checkOsAccountActivated exception:' + JSON.stringify(err));
}

checkOsAccountConstraintEnabled⁹⁺

checkOsAccountConstraintEnabled(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 or ohos.permission.INTERACT_ACROSS_LOCAL_ACCOUNTS

System capability: SystemCapability.Account.OsAccount

Parameters

Error codes

Example: Check whether OS account 100 is forbidden to use Wi-Fi.

let accountManager = account_osAccount.getAccountManager();
let localId = 100;
let constraint = "constraint.wifi";
try {
  accountManager.checkOsAccountConstraintEnabled(localId, constraint, (err, isEnabled)=>{
    if (err) {
      console.log("checkOsAccountConstraintEnabled failed, error: " + JSON.stringify(err));
    } else {
      console.log("checkOsAccountConstraintEnabled successfully, isEnabled: " + isEnabled);
    }
  });
} catch (err) {
  console.log("checkOsAccountConstraintEnabled exception: " + JSON.stringify(err));
}

checkOsAccountConstraintEnabled⁹⁺

checkOsAccountConstraintEnabled(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 or ohos.permission.INTERACT_ACROSS_LOCAL_ACCOUNTS

System capability: SystemCapability.Account.OsAccount

Parameters

Return value

Error codes

Example: Check whether OS account 100 is forbidden to use Wi-Fi.

let accountManager = account_osAccount.getAccountManager();
let localId = 100;
let constraint = "constraint.wifi";
try {
  accountManager.checkOsAccountConstraintEnabled(localId, constraint).then((isEnabled) => {
    console.log("checkOsAccountConstraintEnabled successfully, isEnabled: " + isEnabled);
  }).catch((err) => {
    console.log("checkOsAccountConstraintEnabled failed, error: "  + JSON.stringify(err));
  });
} catch (err) {
  console.log("checkOsAccountConstraintEnabled exception: " + JSON.stringify(err));
}

checkOsAccountTestable⁹⁺

checkOsAccountTestable(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

Error codes

Example

let accountManager = account_osAccount.getAccountManager();
try {
  accountManager.checkOsAccountTestable((err, isTestable) => {
    if (err) {
      console.log("checkOsAccountTestable failed, error: " + JSON.stringify(err));
    } else {
      console.log("checkOsAccountTestable successfully, isTestable: " + isTestable);
    }
  });
} catch (err) {
  console.log("checkOsAccountTestable error: " + JSON.stringify(err));
}

checkOsAccountTestable⁹⁺

checkOsAccountTestable(): 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

Error codes

Example

let accountManager = account_osAccount.getAccountManager();
try {
  accountManager.checkOsAccountTestable().then((isTestable) => {
    console.log("checkOsAccountTestable successfully, isTestable: " + isTestable);
  }).catch((err) => {
    console.log("checkOsAccountTestable failed, error: "  + JSON.stringify(err));
  });
} catch (err) {
  console.log('checkOsAccountTestable exception: ' + JSON.stringify(err));
}

checkOsAccountVerified⁹⁺

checkOsAccountVerified(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

Error codes

Example

let accountManager = account_osAccount.getAccountManager();
try {
  accountManager.checkOsAccountVerified((err, isVerified) => {
    if (err) {
      console.log("checkOsAccountVerified failed, error: " + JSON.stringify(err));
    } else {
      console.log("checkOsAccountVerified successfully, isVerified: " + isVerified);
    }
  });
} catch (err) {
  console.log("checkOsAccountVerified exception: " + JSON.stringify(err));
}

checkOsAccountVerified⁹⁺

checkOsAccountVerified(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

Error codes

Example

let accountManager = account_osAccount.getAccountManager();
let localId = 100;
try {
  accountManager.checkOsAccountVerified(localId, (err, isVerified) => {
    if (err) {
      console.log("checkOsAccountVerified failed, error: " + JSON.stringify(err));
    } else {
      console.log("checkOsAccountVerified successfully, isVerified: " + isVerified);
    }
  });
} catch (err) {
  console.log("checkOsAccountVerified exception: " + err);
}

checkOsAccountVerified⁹⁺

checkOsAccountVerified(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

Return value

Error codes

Example

let accountManager = account_osAccount.getAccountManager();
let localId = 100;
try {
  accountManager.checkOsAccountVerified(localId).then((isVerified) => {
    console.log("checkOsAccountVerified successfully, isVerified: " + isVerified);
  }).catch((err) => {
    console.log("checkOsAccountVerified failed, error: " + JSON.stringify(err));
  });
} catch (err) {
  console.log('checkOsAccountVerified exception: ' + JSON.stringify(err));
}

removeOsAccount

removeOsAccount(localId: number, callback: AsyncCallback<void>): void

Deletes an OS account. This API uses an asynchronous callback to return the result.

System API: This is a system API.

Required permissions: ohos.permission.MANAGE_LOCAL_ACCOUNTS

System capability: SystemCapability.Account.OsAccount

Parameters

Error codes

Example

let accountManager = account_osAccount.getAccountManager();
let accountName = "testAccountName";
try {
  accountManager.createOsAccount(accountName, account_osAccount.OsAccountType.NORMAL, (err, osAccountInfo) => {
    accountManager.removeOsAccount(osAccountInfo.localId, (err)=>{
      if (err) {
        console.log("removeOsAccount failed, error: " + JSON.stringify(err));
      } else {
        console.log("removeOsAccount successfully");
      }
    });
  });
} catch (err) {
  console.log('removeOsAccount exception:' + JSON.stringify(err));
}

removeOsAccount

removeOsAccount(localId: number): Promise<void>

Deletes an OS account. This API uses a promise to return the result.

System API: This is a system API.

Required permissions: ohos.permission.MANAGE_LOCAL_ACCOUNTS

System capability: SystemCapability.Account.OsAccount

Parameters

Return value

Error codes

Example

let accountManager = account_osAccount.getAccountManager();
let accountName = "testAccountName";
try {
  accountManager.createOsAccount(accountName, account_osAccount.OsAccountType.NORMAL, (err, osAccountInfo)=>{
    accountManager.removeOsAccount(osAccountInfo.localId).then(() => {
      console.log("removeOsAccount successfully");
    }).catch((err) => {
        console.log("removeOsAccount failed, error: " + JSON.stringify(err));
    });
  });
} catch (err) {
  console.log("removeOsAccount exception: " + 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.

System API: This is a system API.

Required permissions: ohos.permission.MANAGE_LOCAL_ACCOUNTS

System capability: SystemCapability.Account.OsAccount

Parameters

Error codes

Example: Disable Wi-Fi for OS account 100.

let accountManager = account_osAccount.getAccountManager();
let localId = 100;
let constraint = "constraint.wifi";
try {
  accountManager.setOsAccountConstraints(localId, [constraint], true, (err) => {
    if (err) {
      console.log("setOsAccountConstraints failed, error:" + JSON.stringify(err));
    } else {
      console.log("setOsAccountConstraints successfully");
    }
  });
} catch (err) {
  console.log("setOsAccountConstraints exception: " + 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.

System API: This is a system API.

Required permissions: ohos.permission.MANAGE_LOCAL_ACCOUNTS

System capability: SystemCapability.Account.OsAccount

Parameters

Return value

Error codes

Example: Remove the constraint on the use of Wi-Fi for OS account 100.

let accountManager = account_osAccount.getAccountManager();
let localId = 100;
try {
  accountManager.setOsAccountConstraints(localId, ['constraint.location.set'], false).then(() => {
    console.log('setOsAccountConstraints succsuccessfully');
  }).catch((err) => {
    console.log('setOsAccountConstraints failed, error: '  + JSON.stringify(err));
  });
} catch (err) {
  console.log('setOsAccountConstraints exception:' + 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.

System API: This is a system API.

Required permissions: ohos.permission.MANAGE_LOCAL_ACCOUNTS

System capability: SystemCapability.Account.OsAccount

Parameters

Error codes

Example: Set the name of OS account 100 to demoName.

let accountManager = account_osAccount.getAccountManager();
let localId = 100;
let name = "demoName";
try {
  accountManager.setOsAccountName(localId, name, (err) => {
    if (err) {
      console.log("setOsAccountName failed, error: " + JSON.stringify(err));
    } else {
      console.log("setOsAccountName successfully");
    }
  });
} catch (err) {
  console.log('setOsAccountName exception:' + 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.

System API: This is a system API.

Required permissions: ohos.permission.MANAGE_LOCAL_ACCOUNTS

System capability: SystemCapability.Account.OsAccount

Parameters

Return value

Error codes

Example: Set the name of OS account 100 to demoName.

let accountManager = account_osAccount.getAccountManager();
let localId = 100;
let name = 'testName';
try {
  accountManager.setOsAccountName(localId, name).then(() => {
    console.log('setOsAccountName successfully');
  }).catch((err) => {
    console.log('setOsAccountName failed, error: '  + JSON.stringify(err));
  });
} catch (err) {
  console.log('setOsAccountName exception:' + JSON.stringify(err));
}

getOsAccountCount⁹⁺

getOsAccountCount(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

Error codes

Example

let accountManager = account_osAccount.getAccountManager();
try {
  accountManager.getOsAccountCount((err, count) => {
    if (err) {
      console.log("getOsAccountCount failed, error: " + JSON.stringify(err));
    } else {
      console.log("getOsAccountCount successfully, count: " + count);
    }
  });
} catch (err) {
  console.log("getOsAccountCount exception: " + JSON.stringify(err));
}

getOsAccountCount⁹⁺

getOsAccountCount(): 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

Error codes

Example

let accountManager = account_osAccount.getAccountManager();
try {
  accountManager.getOsAccountCount().then((count) => {
    console.log("getOsAccountCount successfully, count: " + count);
  }).catch((err) => {
    console.log("getOsAccountCount failed, error: " + JSON.stringify(err));
  });
} catch(err) {
  console.log('getOsAccountCount exception:' + JSON.stringify(err));
}

getOsAccountLocalId⁹⁺

getOsAccountLocalId(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

Error codes

Example

let accountManager = account_osAccount.getAccountManager();
try {
  accountManager.getOsAccountLocalId((err, localId) => {
    if (err) {
      console.log("getOsAccountLocalId failed, error: " + JSON.stringify(err));
    } else {
      console.log("getOsAccountLocalId successfully, localId: " + localId);
    }
  });
} catch (err) {
  console.log("getOsAccountLocalId exception: " + JSON.stringify(err));
}

getOsAccountLocalId⁹⁺

getOsAccountLocalId(): 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

Error codes

Example

let accountManager = account_osAccount.getAccountManager();
try {
  accountManager.getOsAccountLocalId().then((localId) => {
    console.log("getOsAccountLocalId successfully, localId: " + localId);
  }).catch((err) => {
    console.log("getOsAccountLocalId failed, error: "  + JSON.stringify(err));
  });
} catch (err) {
  console.log('getOsAccountLocalId exception: ' + JSON.stringify(err));
}

getOsAccountLocalIdForUid⁹⁺

getOsAccountLocalIdForUid(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

Error codes

Example: Obtain the ID of the OS account whose process UID is 12345678.

let accountManager = account_osAccount.getAccountManager();
let uid = 12345678;
try {
  accountManager.getOsAccountLocalIdForUid(uid, (err, localId) => {
    if (err) {
      console.log("getOsAccountLocalIdForUid failed, error: " + JSON.stringify(err));
    }
    console.log("getOsAccountLocalIdForUid successfully, localId: " + localId);
  });
} catch (err) {
  console.log("getOsAccountLocalIdForUid exception: " + JSON.stringify(err));
}

getOsAccountLocalIdForUid⁹⁺

getOsAccountLocalIdForUid(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

Return value

Error codes

Example: Obtain the ID of the OS account whose process UID is 12345678.

let accountManager = account_osAccount.getAccountManager();
let uid = 12345678;
try {
  accountManager.getOsAccountLocalIdForUid(uid).then((localId) => {
    console.log("getOsAccountLocalIdForUid successfully, localId: " + localId);
  }).catch((err) => {
    console.log("getOsAccountLocalIdForUid failed, error: " + JSON.stringify(err));
  });
} catch (err) {
  console.log('getOsAccountLocalIdForUid exception: ' + JSON.stringify(err));
}

getOsAccountLocalIdForDomain⁹⁺

getOsAccountLocalIdForDomain(domainInfo: DomainAccountInfo, callback: AsyncCallback<number>): void

Obtains the OS account ID based on the 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

Error codes

Example

let domainInfo = {domain: 'testDomain', accountName: 'testAccountName'};
let accountManager = account_osAccount.getAccountManager();
try {
  accountManager.getOsAccountLocalIdForDomain(domainInfo, (err, localId) => {
    if (err) {
      console.log("getOsAccountLocalIdForDomain failed, error: " + JSON.stringify(err));
    } else {
      console.log("getOsAccountLocalIdForDomain successfully, localId: " + localId);
    }
  });
} catch (err) {
  console.log('getOsAccountLocalIdForDomain exception: ' + JSON.stringify(err));
}

getOsAccountLocalIdForDomain⁹⁺

getOsAccountLocalIdForDomain(domainInfo: DomainAccountInfo): Promise<number>

Obtains the OS account ID based on the 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

Return value

Error codes

Example

let accountManager = account_osAccount.getAccountManager();
let domainInfo = {domain: 'testDomain', accountName: 'testAccountName'};
try {
  accountManager.getOsAccountLocalIdForDomain(domainInfo).then((localId) => {
    console.log("getOsAccountLocalIdForDomain successfully, localId: " + localId);
  }).catch((err) => {
    console.log("getOsAccountLocalIdForDomain failed, error: "  + JSON.stringify(err));
  });
} catch (err) {
  console.log("getOsAccountLocalIdForDomain exception: " + 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.

System API: This is a system API.

System capability: SystemCapability.Account.OsAccount

Parameters

Error codes

Example

let accountManager = account_osAccount.getAccountManager();
try {
  accountManager.queryMaxOsAccountNumber((err, maxCnt) => {
    if (err) {
      console.log('queryMaxOsAccountNumber failed, error:' + JSON.stringify(err));
    } else {
      console.log('queryMaxOsAccountNumber successfully, maxCnt:' + maxCnt);
    }
  });
} catch (err) {
  console.log('queryMaxOsAccountNumber exception:' + JSON.stringify(err));
}

queryMaxOsAccountNumber

queryMaxOsAccountNumber(): Promise<number>

Obtains the maximum number of OS accounts that can be created. This API uses a promise to return the result.

System API: This is a system API.

System capability: SystemCapability.Account.OsAccount

Return value

Error codes

Example

let accountManager = account_osAccount.getAccountManager();
try {
  accountManager.queryMaxOsAccountNumber().then((maxCnt) => {
    console.log('queryMaxOsAccountNumber successfully, maxCnt: ' + maxCnt);
  }).catch((err) => {
    console.log('queryMaxOsAccountNumber failed, error: '  + JSON.stringify(err));
  });
} catch (err) {
  console.log('queryMaxOsAccountNumber exception:' + JSON.stringify(err));
}

getOsAccountConstraints⁹⁺

getOsAccountConstraints(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

Error codes

Example: Obtain all constraints of OS account 100.

let accountManager = account_osAccount.getAccountManager();
let localId = 100;
try {
  accountManager.getOsAccountConstraints(localId, (err, constraints) => {
    if (err) {
      console.log("getOsAccountConstraints failed, err: " + JSON.stringify(err));
    } else {
      console.log("getOsAccountConstraints successfully, constraints: " + JSON.stringify(constraints));
    }
  });
} catch (err) {
  console.log('getOsAccountConstraints exception:' + JSON.stringify(err));
}

getOsAccountConstraints⁹⁺

getOsAccountConstraints(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

Return value

Error codes

Example: Obtain all constraints of OS account 100.

let accountManager = account_osAccount.getAccountManager();
let localId = 100;
try {
  accountManager.getOsAccountConstraints(localId).then((constraints) => {
    console.log('getOsAccountConstraints, constraints: ' + constraints);
  }).catch((err) => {
    console.log('getOsAccountConstraints err: '  + JSON.stringify(err));
  });
} catch (e) {
  console.log('getOsAccountConstraints exception:' + JSON.stringify(e));
}

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.

System API: This is a system API.

System capability: SystemCapability.Account.OsAccount

Required permissions: ohos.permission.MANAGE_LOCAL_ACCOUNTS

Parameters

Error codes

Example

let accountManager = account_osAccount.getAccountManager();
try {
  accountManager.queryAllCreatedOsAccounts((err, accountArr)=>{
    console.log('queryAllCreatedOsAccounts err:' + JSON.stringify(err));
    console.log('queryAllCreatedOsAccounts accountArr:' + JSON.stringify(accountArr));
  });
} catch (e) {
  console.log('queryAllCreatedOsAccounts exception:' + JSON.stringify(e));
}

queryAllCreatedOsAccounts

queryAllCreatedOsAccounts(): Promise<Array<OsAccountInfo>>

Obtains information about all the OS accounts created. This API uses a promise to return the result.

System API: This is a system API.

System capability: SystemCapability.Account.OsAccount

Required permissions: ohos.permission.MANAGE_LOCAL_ACCOUNTS

Return value

Error codes

Example

let accountManager = account_osAccount.getAccountManager();
try {
  accountManager.queryAllCreatedOsAccounts().then((accountArr) => {
    console.log('queryAllCreatedOsAccounts, accountArr: ' + JSON.stringify(accountArr));
  }).catch((err) => {
    console.log('queryAllCreatedOsAccounts err: '  + JSON.stringify(err));
  });
} catch (e) {
  console.log('queryAllCreatedOsAccounts exception:' + JSON.stringify(e));
}

getActivatedOsAccountLocalIds⁹⁺

getActivatedOsAccountLocalIds(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

Error codes

Example

let accountManager = account_osAccount.getAccountManager();
try {
  accountManager.getActivatedOsAccountLocalIds((err, idArray)=>{
    console.log('getActivatedOsAccountLocalIds err:' + JSON.stringify(err));
    console.log('getActivatedOsAccountLocalIds idArray length:' + idArray.length);
    for(let i=0;i<idArray.length;i++) {
      console.info('activated os account id: ' + idArray[i]);
    }
  });
} catch (e) {
  console.log('getActivatedOsAccountLocalIds exception:' + JSON.stringify(e));
}

getActivatedOsAccountLocalIds⁹⁺

getActivatedOsAccountLocalIds(): 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

Error codes

Example

let accountManager = account_osAccount.getAccountManager();
try {
  accountManager.getActivatedOsAccountLocalIds().then((idArray) => {
    console.log('getActivatedOsAccountLocalIds, idArray: ' + idArray);
  }).catch((err) => {
    console.log('getActivatedOsAccountLocalIds err: '  + JSON.stringify(err));
  });
} catch (e) {
  console.log('getActivatedOsAccountLocalIds exception:' + JSON.stringify(e));
}

createOsAccount

createOsAccount(localName: string, type: OsAccountType, callback: AsyncCallback<OsAccountInfo>): void

Creates an OS account. This API uses an asynchronous callback to return the result.

System API: This is a system API.

Required permissions: ohos.permission.MANAGE_LOCAL_ACCOUNTS

System capability: SystemCapability.Account.OsAccount

Parameters

Error codes

Example

let accountManager = account_osAccount.getAccountManager();
try {
  accountManager.createOsAccount('testName', account_osAccount.OsAccountType.NORMAL, (err, osAccountInfo)=>{
    console.log('createOsAccount err:' + JSON.stringify(err));
    console.log('createOsAccount osAccountInfo:' + JSON.stringify(osAccountInfo));
  });
} catch (e) {
  console.log('createOsAccount exception:' + JSON.stringify(e));
}

createOsAccount

createOsAccount(localName: string, type: OsAccountType): Promise<OsAccountInfo>

Creates an OS account. This API uses a promise to return the result.

System API: This is a system API.

Required permissions: ohos.permission.MANAGE_LOCAL_ACCOUNTS

System capability: SystemCapability.Account.OsAccount

Parameters

Return value

Error codes

Example

let accountManager = account_osAccount.getAccountManager();
try {
  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));
  });
} catch (e) {
  console.log('createOsAccount exception:' + JSON.stringify(e));
}

createOsAccountForDomain⁸⁺

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.

System API: This is a system API.

Required permissions: ohos.permission.MANAGE_LOCAL_ACCOUNTS

System capability: SystemCapability.Account.OsAccount

Parameters

Error codes

Example

let accountManager = account_osAccount.getAccountManager();
let domainInfo = {domain: 'testDomain', accountName: 'testAccountName'};
try {
  accountManager.createOsAccountForDomain(account_osAccount.OsAccountType.NORMAL, domainInfo, (err, osAccountInfo)=>{
    console.log('createOsAccountForDomain err:' + JSON.stringify(err));
    console.log('createOsAccountForDomain osAccountInfo:' + JSON.stringify(osAccountInfo));
  });
} catch (e) {
  console.log('createOsAccountForDomain exception:' + JSON.stringify(e));
}

createOsAccountForDomain⁸⁺

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.

System API: This is a system API.

Required permissions: ohos.permission.MANAGE_LOCAL_ACCOUNTS

System capability: SystemCapability.Account.OsAccount

Parameters

Return value

Error codes

Example

let accountManager = account_osAccount.getAccountManager();
let domainInfo = {domain: 'testDomain', accountName: 'testAccountName'};
try {
  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));
  });
} catch (e) {
  console.log('createOsAccountForDomain exception:' + JSON.stringify(e));
}

getCurrentOsAccount⁹⁺

getCurrentOsAccount(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

Error codes

Example

let accountManager = account_osAccount.getAccountManager();
try {
  accountManager.getCurrentOsAccount((err, curAccountInfo)=>{
    console.log('getCurrentOsAccount err:' + JSON.stringify(err));
    console.log('getCurrentOsAccount curAccountInfo:' + JSON.stringify(curAccountInfo));
  });
} catch (e) {
  console.log('getCurrentOsAccount exception:' + JSON.stringify(e));
}

getCurrentOsAccount⁹⁺

getCurrentOsAccount(): 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

Error codes

Example

let accountManager = account_osAccount.getAccountManager();
try {
  accountManager.getCurrentOsAccount().then((accountInfo) => {
    console.log('getCurrentOsAccount, accountInfo: ' + JSON.stringify(accountInfo));
  }).catch((err) => {
    console.log('getCurrentOsAccount err: '  + JSON.stringify(err));
  });
} catch (e) {
  console.log('getCurrentOsAccount exception:' + JSON.stringify(e));
}

queryOsAccountById

queryOsAccountById(localId: number, callback: AsyncCallback<OsAccountInfo>): void

Obtains information about the OS account of the given ID. This API uses an asynchronous callback to return the result.

System API: This is a system API.

Required permissions: ohos.permission.MANAGE_LOCAL_ACCOUNTS or ohos.permission.INTERACT_ACROSS_LOCAL_ACCOUNTS_EXTENSION

System capability: SystemCapability.Account.OsAccount

Parameters

Error codes

Example: Query information about OS account 100.

let accountManager = account_osAccount.getAccountManager();
let localId = 100;
try {
  accountManager.queryOsAccountById(localId, (err, accountInfo)=>{
    console.log('queryOsAccountById err:' + JSON.stringify(err));
    console.log('queryOsAccountById accountInfo:' + JSON.stringify(accountInfo));
  });
} catch (e) {
  console.log('queryOsAccountById exception:' + JSON.stringify(e));
}

queryOsAccountById

queryOsAccountById(localId: number): Promise<OsAccountInfo>

Obtains information about the OS account of the given ID. This API uses a promise to return the result.

System API: This is a system API.

Required permissions: ohos.permission.MANAGE_LOCAL_ACCOUNTS or ohos.permission.INTERACT_ACROSS_LOCAL_ACCOUNTS_EXTENSION

System capability: SystemCapability.Account.OsAccount

Parameters

Return value

Error codes

Example: Query information about OS account 100.

let accountManager = account_osAccount.getAccountManager();
let localId = 100;
try {
  accountManager.queryOsAccountById(localId).then((accountInfo) => {
    console.log('queryOsAccountById, accountInfo: ' + JSON.stringify(accountInfo));
  }).catch((err) => {
    console.log('queryOsAccountById err: '  + JSON.stringify(err));
  });
} catch (e) {
  console.log('queryOsAccountById exception:' + JSON.stringify(e));
}

getOsAccountType⁹⁺

getOsAccountType(callback: AsyncCallback<OsAccountType>): void

Obtains the type of the account to which the current process belongs. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.Account.OsAccount

Parameters

Error codes

Example

let accountManager = account_osAccount.getAccountManager();
try {
  accountManager.getOsAccountType((err, accountType) => {
    console.log('getOsAccountType err: ' + JSON.stringify(err));
    console.log('getOsAccountType accountType: ' + accountType);
  });
} catch (e) {
  console.log('getOsAccountType exception: ' + JSON.stringify(e));
}

getOsAccountType⁹⁺

getOsAccountType(): Promise<OsAccountType>

Obtains the type of the account to which the current process belongs. This API uses a promise to return the result.

System capability: SystemCapability.Account.OsAccount

Return value

Error codes

Example

let accountManager = account_osAccount.getAccountManager();
try {
  accountManager.getOsAccountType().then((accountType) => {
    console.log('getOsAccountType, accountType: ' + accountType);
  }).catch((err) => {
    console.log('getOsAccountType err: '  + JSON.stringify(err));
  });
} catch (e) {
  console.log('getOsAccountType exception: ' + JSON.stringify(e));
}

queryDistributedVirtualDeviceId⁹⁺

queryDistributedVirtualDeviceId(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

Error codes

Example

let accountManager = account_osAccount.getAccountManager();
try {
  accountManager.queryDistributedVirtualDeviceId((err, virtualID) => {
    console.log('queryDistributedVirtualDeviceId err: ' + JSON.stringify(err));
    console.log('queryDistributedVirtualDeviceId virtualID: ' + virtualID);
  });
} catch (e) {
  console.log('queryDistributedVirtualDeviceId exception: ' + JSON.stringify(e));
}

queryDistributedVirtualDeviceId⁹⁺

queryDistributedVirtualDeviceId(): 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

Error codes

Example

let accountManager = account_osAccount.getAccountManager();
try {
  accountManager.queryDistributedVirtualDeviceId().then((virtualID) => {
    console.log('queryDistributedVirtualDeviceId, virtualID: ' + virtualID);
  }).catch((err) => {
    console.log('queryDistributedVirtualDeviceId err: '  + JSON.stringify(err));
  });
} catch (e) {
  console.log('queryDistributedVirtualDeviceId exception: ' + JSON.stringify(e));
}

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.

System API: This is a system API.

Required permissions: ohos.permission.MANAGE_LOCAL_ACCOUNTS

System capability: SystemCapability.Account.OsAccount

Parameters

Error codes

Example: Obtain the profile photo of OS account 100.

let accountManager = account_osAccount.getAccountManager();
let localId = 100;
try {
  accountManager.getOsAccountProfilePhoto(localId, (err, photo)=>{
    console.log('getOsAccountProfilePhoto err:' + JSON.stringify(err));
    console.log('get photo:' + photo + ' by localId: ' + localId);
  });
} catch (e) {
  console.log('getOsAccountProfilePhoto exception:' + JSON.stringify(e));
}

getOsAccountProfilePhoto

getOsAccountProfilePhoto(localId: number): Promise<string>

Obtains the profile photo of an OS account. This API uses a promise to return the result.

System API: This is a system API.

Required permissions: ohos.permission.MANAGE_LOCAL_ACCOUNTS

System capability: SystemCapability.Account.OsAccount

Parameters

Return value

Error codes

Example: Obtain the profile photo of OS account 100.

let accountManager = account_osAccount.getAccountManager();
let localId = 100;
try {
  accountManager.getOsAccountProfilePhoto(localId).then((photo) => {
    console.log('getOsAccountProfilePhoto: ' + photo);
  }).catch((err) => {
    console.log('getOsAccountProfilePhoto err: '  + JSON.stringify(err));
  });
} catch (e) {
  console.log('getOsAccountProfilePhoto exception:' + JSON.stringify(e));
}

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.

System API: This is a system API.

Required permissions: ohos.permission.MANAGE_LOCAL_ACCOUNTS

System capability: SystemCapability.Account.OsAccount

Parameters

Error codes

Example: Set a profile photo for OS account 100.

let accountManager = account_osAccount.getAccountManager();
let localId = 100;
let photo = 'data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAA0AAAAPCAYAAAA/I0V3AAAAAXNSR0IArs4c6QAAAARnQU1BAA'+
'Cxjwv8YQUAAAAJcEhZcwAADsMAAA7DAcdvqGQAAACwSURBVDhPvZLBDYMwDEV/ugsXRjAT0EHCOuFIBwkbdIRewi6unbiAyoGgSn1SFH85+Y'+
'q/4ljARW62X+LHS8uIzjm4dXUYF+utzBikB52Jo5e5iEPKqpACk7R9NM2RvWm5tIkD2czLCUFNKLD6IjdMHFHDzws285MgGrT0xCtp3WOKHo'+
'+7q0mP0DZW9pNmoEFUzrQjp5cCnaen2kSJXLFD8ghbXyZCMQf/8e8Ns1XVAG/XAgqKzVnJFAAAAABJRU5ErkJggg=='
try {
  accountManager.setOsAccountProfilePhoto(localId, photo, (err)=>{
    console.log('setOsAccountProfilePhoto err:' + JSON.stringify(err));
  });
} catch (e) {
  console.log('setOsAccountProfilePhoto exception:' + JSON.stringify(e));
}

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.

System API: This is a system API.

Required permissions: ohos.permission.MANAGE_LOCAL_ACCOUNTS

System capability: SystemCapability.Account.OsAccount

Parameters

Return value

Error codes

Example: Set a profile photo for OS account 100.

let accountManager = account_osAccount.getAccountManager();
let localId = 100;
let photo = 'data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAA0AAAAPCAYAAAA/I0V3AAAAAXNSR0IArs4c6QAAAARnQU1BAA'+
'Cxjwv8YQUAAAAJcEhZcwAADsMAAA7DAcdvqGQAAACwSURBVDhPvZLBDYMwDEV/ugsXRjAT0EHCOuFIBwkbdIRewi6unbiAyoGgSn1SFH85+Y'+
'q/4ljARW62X+LHS8uIzjm4dXUYF+utzBikB52Jo5e5iEPKqpACk7R9NM2RvWm5tIkD2czLCUFNKLD6IjdMHFHDzws285MgGrT0xCtp3WOKHo'+
'+7q0mP0DZW9pNmoEFUzrQjp5cCnaen2kSJXLFD8ghbXyZCMQf/8e8Ns1XVAG/XAgqKzVnJFAAAAABJRU5ErkJggg=='
try {
  accountManager.setOsAccountProfilePhoto(localId, photo).then(() => {
    console.log('setOsAccountProfilePhoto success');
  }).catch((err) => {
    console.log('setOsAccountProfilePhoto err: '  + JSON.stringify(err));
  });
} catch (e) {
  console.log('setOsAccountProfilePhoto exception:' + JSON.stringify(e));
}

getOsAccountLocalIdForSerialNumber⁹⁺

getOsAccountLocalIdForSerialNumber(serialNumber: number, callback: AsyncCallback<number>): void

Obtains the OS account ID based on the serial number (SN). This API uses an asynchronous callback to return the result.

System capability: SystemCapability.Account.OsAccount

Parameters

Error codes

Example: Obtain the ID of the OS account whose SN is 12345.

let accountManager = account_osAccount.getAccountManager();
let serialNumber = 12345;
try {
  accountManager.getOsAccountLocalIdForSerialNumber(serialNumber, (err, localId)=>{
    console.log('ger localId err:' + JSON.stringify(err));
    console.log('get localId:' + localId + ' by serialNumber: ' + serialNumber);
  });
} catch (e) {
  console.log('ger localId exception:' + JSON.stringify(e));
}

getOsAccountLocalIdForSerialNumber⁹⁺

getOsAccountLocalIdForSerialNumber(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

Return value

Error codes

Example: Obtain the ID of the OS account whose SN is 12345.

let accountManager = account_osAccount.getAccountManager();
let serialNumber = 12345;
try {
  accountManager.getOsAccountLocalIdForSerialNumber(serialNumber).then((localId) => {
    console.log('getOsAccountLocalIdForSerialNumber localId: ' + localId);
  }).catch((err) => {
    console.log('getOsAccountLocalIdForSerialNumber err: '  + JSON.stringify(err));
  });
} catch (e) {
  console.log('getOsAccountLocalIdForSerialNumber exception: '  + JSON.stringify(e));
}

getSerialNumberForOsAccountLocalId⁹⁺

getSerialNumberForOsAccountLocalId(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

Error codes

Example: Obtain the SN of the OS account 100.

let accountManager = account_osAccount.getAccountManager();
let localId = 100;
try {
  accountManager.getSerialNumberForOsAccountLocalId(localId, (err, serialNumber)=>{
    console.log('ger serialNumber err:' + JSON.stringify(err));
    console.log('get serialNumber:' + serialNumber + ' by localId: ' + localId);
  });
} catch (e) {
  console.log('ger serialNumber exception:' + JSON.stringify(e));
}

getSerialNumberForOsAccountLocalId⁹⁺

getSerialNumberForOsAccountLocalId(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

Return value

Error codes

Example: Obtain the SN of the OS account 100.

let accountManager = account_osAccount.getAccountManager();
let localId = 100;
try {
  accountManager.getSerialNumberForOsAccountLocalId(localId).then((serialNumber) => {
    console.log('getSerialNumberForOsAccountLocalId serialNumber: ' + serialNumber);
  }).catch((err) => {
    console.log('getSerialNumberForOsAccountLocalId err: '  + JSON.stringify(err));
  });
} catch (e) {
  console.log('getSerialNumberForOsAccountLocalId exception:' + JSON.stringify(e));
}

on

on(type: 'activate' | 'activating', name: string, callback: Callback<number>): void

Subscribes to the OS account activation states, including the states of the account being activated and the account with activation completed. This API uses an asynchronous callback to return the result.

System API: This is a system API.

Required permissions: ohos.permission.INTERACT_ACROSS_LOCAL_ACCOUNTS_EXTENSION

System capability: SystemCapability.Account.OsAccount

Parameters

Error codes

Example

let accountManager = account_osAccount.getAccountManager();
function onCallback(receiveLocalId){
  console.log('receive localId:' + receiveLocalId);
}
try {
  accountManager.on('activating', 'osAccountOnOffNameA', onCallback);
} catch (e) {
  console.log('receive localId exception:' + JSON.stringify(e));
}

off

off(type: 'activate' | 'activating', name: string, callback?: Callback<number>): void

Unsubscribes from the OS account activation states, including the states of the account being activated and the account with activation completed. This API uses an asynchronous callback to return the result.

System API: This is a system API.

Required permissions: ohos.permission.INTERACT_ACROSS_LOCAL_ACCOUNTS_EXTENSION

System capability: SystemCapability.Account.OsAccount

Parameters

Error codes

Example

let accountManager = account_osAccount.getAccountManager();
function offCallback(){
  console.log('off enter')
}
try {
  accountManager.off('activating', 'osAccountOnOffNameA', offCallback);
} catch (e) {
  console.log('off exception:' + JSON.stringify(e));
}

getBundleIdForUid⁹⁺

getBundleIdForUid(uid: number, callback: AsyncCallback<number>): void;

Obtains the bundle ID based on the UID. This API uses an asynchronous callback to return the result.

System API: This is a system API.

System capability: SystemCapability.Account.OsAccount

Parameters

Error codes

Example

let accountManager = account_osAccount.getAccountManager();
let testUid = 1000000;
try {
  accountManager.getBundleIdForUid(testUid, (err, bundleId) => {
    console.info('getBundleIdForUid errInfo:' + JSON.stringify(err));
    console.info('getBundleIdForUid bundleId:' + JSON.stringify(bundleId));
  });
} catch (e) {
  console.info('getBundleIdForUid exception:' + JSON.stringify(e));
}

getBundleIdForUid⁹⁺

getBundleIdForUid(uid: number): Promise<number>;

Obtains the bundle ID based on the UID. This API uses a promise to return the result.

System API: This is a system API.

System capability: SystemCapability.Account.OsAccount

Parameters

Return value

Error codes

Example

let accountManager = account_osAccount.getAccountManager();
let testUid = 1000000;
try {
  accountManager.getBundleIdForUid(testUid).then((result) => {
    console.info('getBundleIdForUid bundleId:' + JSON.stringify(result));
  }).catch((err)=>{
    console.info('getBundleIdForUid errInfo:' + JSON.stringify(err));
  });
} catch (e) {
  console.info('getBundleIdForUid exception:' + JSON.stringify(e));
}

isMainOsAccount⁹⁺

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.

System API: This is a system API.

Required permissions: ohos.permission.MANAGE_LOCAL_ACCOUNTS

System capability: SystemCapability.Account.OsAccount

Parameters

Error codes

Example

let accountManager = account_osAccount.getAccountManager();
try {
  accountManager.isMainOsAccount((err,result)=>{
    console.info('isMainOsAccount errInfo:' + JSON.stringify(err));
    console.info('isMainOsAccount result:' + JSON.stringify(result));
  });
} catch (e) {
  console.info('isMainOsAccount exception:' + JSON.stringify(e));
}

isMainOsAccount⁹⁺

isMainOsAccount(): Promise<boolean>;

Checks whether the current process belongs to the main OS account. This API uses a promise to return the result.

System API: This is a system API.

Required permissions: ohos.permission.MANAGE_LOCAL_ACCOUNTS

System capability: SystemCapability.Account.OsAccount

Return value

Error codes

Example

let accountManager = account_osAccount.getAccountManager();
try {
  accountManager.isMainOsAccount().then((result) => {
    console.info('isMainOsAccount result:' + JSON.stringify(result));
  }).catch((err)=>{
    console.info('isMainOsAccount errInfo:' + JSON.stringify(err));
  });
} catch (e) {
  console.info('isMainOsAccount exception:' + JSON.stringify(e));
}

getOsAccountConstraintSourceTypes⁹⁺

getOsAccountConstraintSourceTypes(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.

System API: This is a system API.

Required permissions: ohos.permission.MANAGE_LOCAL_ACCOUNTS

System capability: SystemCapability.Account.OsAccount

Parameters

Error codes

Example

let accountManager = account_osAccount.getAccountManager();
try {
  accountManager.getOsAccountConstraintSourceTypes(100, 'constraint.wifi',(err,sourceTypeInfos)=>{
    console.info('getOsAccountConstraintSourceTypes errInfo:' + JSON.stringify(err));
    console.info('getOsAccountConstraintSourceTypes sourceTypeInfos:' + JSON.stringify(sourceTypeInfos));
  });
} catch (e) {
  console.info('getOsAccountConstraintSourceTypes exception:' + JSON.stringify(e));
}

getOsAccountConstraintSourceTypes⁹⁺

getOsAccountConstraintSourceTypes(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.

System API: This is a system API.

Required permissions: ohos.permission.MANAGE_LOCAL_ACCOUNTS

System capability: SystemCapability.Account.OsAccount

Parameters

Return value

Error codes

Example

let accountManager = account_osAccount.getAccountManager();
try {
  accountManager.getOsAccountConstraintSourceTypes(100, 'constraint.wifi').then((result) => {
    console.info('getOsAccountConstraintSourceTypes sourceTypeInfos:' + JSON.stringify(result));
  }).catch((err)=>{
    console.info('getOsAccountConstraintSourceTypes errInfo:' + JSON.stringify(err));
  });
} catch (e) {
  console.info('getOsAccountConstraintSourceTypes exception:' + JSON.stringify(e));
}

isMultiOsAccountEnable^(deprecated)

isMultiOsAccountEnable(callback: AsyncCallback<boolean>): void

Checks whether multiple OS accounts are supported. This API uses an asynchronous callback to return the result.

NOTE

This API is supported since API version 7 and deprecated since API version 9. You are advised to use checkMultiOsAccountEnabled.

System capability: SystemCapability.Account.OsAccount

Parameters

Example

let accountManager = account_osAccount.getAccountManager();
accountManager.isMultiOsAccountEnable((err, isEnabled) => {
  if (err) {
    console.log("isMultiOsAccountEnable failed, error: " + JSON.stringify(err));
  } else {
  console.log("isMultiOsAccountEnable successfully, isEnabled: " + isEnabled);
  }
});

isMultiOsAccountEnable^(deprecated)

isMultiOsAccountEnable(): Promise<boolean>

Checks whether multiple OS accounts are supported. This API uses a promise to return the result.

NOTE

This API is supported since API version 7 and deprecated since API version 9. You are advised to use checkMultiOsAccountEnabled.

System capability: SystemCapability.Account.OsAccount

Return value

Example

let accountManager = account_osAccount.getAccountManager();
accountManager.isMultiOsAccountEnable().then((isEnabled) => {
  console.log('isMultiOsAccountEnable successfully, isEnabled: ' + isEnabled);
}).catch((err) => {
  console.log('isMultiOsAccountEnable failed, error: '  + JSON.stringify(err));
});

isOsAccountActived^(deprecated)

isOsAccountActived(localId: number, callback: AsyncCallback<boolean>): void

Checks whether an OS account is activated. This API uses an asynchronous callback to return the result.

NOTE

This API is supported since API version 7 and deprecated since API version 9. You are advised to use checkOsAccountActivated.

Required permissions: ohos.permission.MANAGE_LOCAL_ACCOUNTS or ohos.permission.INTERACT_ACROSS_LOCAL_ACCOUNTS

System capability: SystemCapability.Account.OsAccount

Parameters

Example: Check whether OS account 100 is activated.

let accountManager = account_osAccount.getAccountManager();
let localId = 100;
accountManager.isOsAccountActived(localId, (err, isActived) => {
  if (err) {
    console.log('isOsAccountActived failed, err:' + JSON.stringify(err));
  } else {
    console.log('isOsAccountActived successfully, isActived:' + isActived);
  }
});

isOsAccountActived^(deprecated)

isOsAccountActived(localId: number): Promise<boolean>

Checks whether an OS account is activated. This API uses a promise to return the result.

NOTE

This API is supported since API version 7 and deprecated since API version 9. You are advised to use checkOsAccountActivated.

Required permissions: ohos.permission.MANAGE_LOCAL_ACCOUNTS or ohos.permission.INTERACT_ACROSS_LOCAL_ACCOUNTS

System capability: SystemCapability.Account.OsAccount

Parameters

Return value

Example: Check whether OS account 100 is activated.

let accountManager = account_osAccount.getAccountManager();
let localId = 100;
accountManager.isOsAccountActived(localId).then((isActived) => {
  console.log('isOsAccountActived successfully, isActived: ' + isActived);
}).catch((err) => {
  console.log('isOsAccountActived failed, error: '  + JSON.stringify(err));
});

isOsAccountConstraintEnable^(deprecated)

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.

NOTE

This API is supported since API version 7 and deprecated since API version 9. You are advised to use checkOsAccountConstraintEnabled.

Required permissions: ohos.permission.MANAGE_LOCAL_ACCOUNTS

System capability: SystemCapability.Account.OsAccount

Parameters

Example: Check whether OS account 100 is forbidden to use Wi-Fi.

let accountManager = account_osAccount.getAccountManager();
let localId = 100;
let constraint = "constraint.wifi";
accountManager.isOsAccountConstraintEnable(localId, constraint, (err, isEnabled) => {
  if (err) {
    console.log("isOsAccountConstraintEnable failed, error:" + JSON.stringify(err));
  } else {
    console.log("isOsAccountConstraintEnable successfully, isEnabled:" + isEnabled);
  }
});

isOsAccountConstraintEnable^(deprecated)

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.

NOTE

This API is supported since API version 7 and deprecated since API version 9. You are advised to use checkOsAccountConstraintEnabled.

Required permissions: ohos.permission.MANAGE_LOCAL_ACCOUNTS

System capability: SystemCapability.Account.OsAccount

Parameters

Return value

Example: Check whether OS account 100 is forbidden to use Wi-Fi.

let accountManager = account_osAccount.getAccountManager();
let localId = 100;
let constraint = "constraint.wifi";
accountManager.isOsAccountConstraintEnable(localId, constraint).then((isEnabled) => {
  console.log("isOsAccountConstraintEnable successfully, isEnabled: " + isEnabled);
}).catch((err) => {
  console.log("isOsAccountConstraintEnable err: "  + JSON.stringify(err));
});

isTestOsAccount^(deprecated)

isTestOsAccount(callback: AsyncCallback<boolean>): void

Checks whether this OS account is a test account. This API uses an asynchronous callback to return the result.

NOTE

This API is supported since API version 7 and deprecated since API version 9. You are advised to use checkOsAccountTestable.

System capability: SystemCapability.Account.OsAccount

Parameters

Example

let accountManager = account_osAccount.getAccountManager();
accountManager.isTestOsAccount((err, isTestable) => {
  if (err) {
    console.log("isTestOsAccount failed, error: " + JSON.stringify(err));
  } else {
    console.log("isTestOsAccount successfully, isTestable: " + isTestable);
  }
});

isTestOsAccount^(deprecated)

isTestOsAccount(): Promise<boolean>

Checks whether this OS account is a test account. This API uses a promise to return the result.

NOTE

This API is supported since API version 7 and deprecated since API version 9. You are advised to use checkOsAccountTestable.

System capability: SystemCapability.Account.OsAccount

Return value

Example

let accountManager = account_osAccount.getAccountManager();
accountManager.isTestOsAccount().then((isTestable) => {
    console.log("isTestOsAccount successfully, isTestable: " + isTestable);
}).catch((err) => {
    console.log("isTestOsAccount failed, error: " + JSON.stringify(err));
});

isOsAccountVerified^(deprecated)

isOsAccountVerified(callback: AsyncCallback<boolean>): void

Checks whether this OS account has been verified. This API uses an asynchronous callback to return the result.

NOTE

This API is supported since API version 7 and deprecated since API version 9. You are advised to use checkOsAccountVerified.

Required permissions: ohos.permission.MANAGE_LOCAL_ACCOUNTS or ohos.permission.INTERACT_ACROSS_LOCAL_ACCOUNTS

System capability: SystemCapability.Account.OsAccount

Parameters

Example

let accountManager = account_osAccount.getAccountManager();
accountManager.isOsAccountVerified((err, isVerified) => {
  if (err) {
    console.log("isOsAccountVerified failed, error: " + JSON.stringify(err));
  } else {
    console.log("isOsAccountVerified successfully, isVerified: " + isVerified);
  }
});

isOsAccountVerified^(deprecated)

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.

NOTE

This API is supported since API version 7 and deprecated since API version 9. You are advised to use checkOsAccountVerified.

Required permissions: ohos.permission.MANAGE_LOCAL_ACCOUNTS or ohos.permission.INTERACT_ACROSS_LOCAL_ACCOUNTS

System capability: SystemCapability.Account.OsAccount

Parameters

Example

let accountManager = account_osAccount.getAccountManager();
let localId = 100;
accountManager.isOsAccountVerified(localId, (err, isVerified) => {
  if (err) {
    console.log("isOsAccountVerified failed, error: " + JSON.stringify(err));
  } else {
    console.log("isOsAccountVerified successfully, isVerified: " + isVerified);
  }
});

isOsAccountVerified^(deprecated)

isOsAccountVerified(localId?: number): Promise<boolean>

Checks whether an OS account has been verified. This API uses a promise to return the result.

NOTE

This API is supported since API version 7 and deprecated since API version 9. You are advised to use checkOsAccountVerified.

Required permissions: ohos.permission.MANAGE_LOCAL_ACCOUNTS or ohos.permission.INTERACT_ACROSS_LOCAL_ACCOUNTS

System capability: SystemCapability.Account.OsAccount

Parameters

Return value

Example

let accountManager = account_osAccount.getAccountManager();
accountManager.isOsAccountVerified(localId).then((isVerified) => {
  console.log("isOsAccountVerified successfully, isVerified: " + isVerified);
}).catch((err) => {
  console.log("isOsAccountVerified failed, error: " + JSON.stringify(err));
});

getCreatedOsAccountsCount^(deprecated)

getCreatedOsAccountsCount(callback: AsyncCallback<number>): void

Obtains the number of OS accounts created. This API uses an asynchronous callback to return the result.

NOTE

This API is supported since API version 7 and deprecated since API version 9. You are advised to use getOsAccountCount.

Required permissions: ohos.permission.MANAGE_LOCAL_ACCOUNTS

System capability: SystemCapability.Account.OsAccount

Parameters

Example

let accountManager = account_osAccount.getAccountManager();
accountManager.getCreatedOsAccountsCount((err, count)=>{
  if (err) {
    console.log("getCreatedOsAccountsCount failed, error: " + JSON.stringify(err));
  } else {
    console.log("getCreatedOsAccountsCount successfully, count: " + count);
  }
});

getCreatedOsAccountsCount^(deprecated)

getCreatedOsAccountsCount(): Promise<number>

Obtains the number of OS accounts created. This API uses a promise to return the result.

NOTE

This API is supported since API version 7 and deprecated since API version 9. You are advised to use getOsAccountCount.

Required permissions: ohos.permission.MANAGE_LOCAL_ACCOUNTS

System capability: SystemCapability.Account.OsAccount

Return value

Example

let accountManager = account_osAccount.getAccountManager();
accountManager.getCreatedOsAccountsCount().then((count) => {
  console.log("getCreatedOsAccountsCount successfully, count: " + count);
}).catch((err) => {
  console.log("getCreatedOsAccountsCount failed, error: "  + JSON.stringify(err));
});

getOsAccountLocalIdFromProcess^(deprecated)

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.

NOTE

This API is supported since API version 7 and deprecated since API version 9. You are advised to use getOsAccountLocalId.

System capability: SystemCapability.Account.OsAccount

Parameters

Example

let accountManager = account_osAccount.getAccountManager();
accountManager.getOsAccountLocalIdFromProcess((err, localId) => {
  if (err) {
    console.log("getOsAccountLocalIdFromProcess failed, error: " + JSON.stringify(err));
  } else {
    console.log("getOsAccountLocalIdFromProcess successfully, localId: " + localId);
  }
});

getOsAccountLocalIdFromProcess^(deprecated)

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.

NOTE

This API is supported since API version 7 and deprecated since API version 9. You are advised to use getOsAccountLocalId.

System capability: SystemCapability.Account.OsAccount

Return value

Example

let accountManager = account_osAccount.getAccountManager();
accountManager.getOsAccountLocalIdFromProcess().then((localId) => {
  console.log('getOsAccountLocalIdFromProcess successfully, localId: ' + localId);
}).catch((err) => {
  console.log('getOsAccountLocalIdFromProcess failed, error: '  + JSON.stringify(err));
});

getOsAccountLocalIdFromUid^(deprecated)

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.

NOTE

This API is supported since API version 7 and deprecated since API version 9. You are advised to use getOsAccountLocalIdForUid.

System capability: SystemCapability.Account.OsAccount

Parameters

Example: Obtain the ID of the OS account whose process UID is 12345678.

let accountManager = account_osAccount.getAccountManager();
let uid = 12345678;
accountManager.getOsAccountLocalIdFromUid(uid, (err, localId) => {
  if (err) {
    console.log("getOsAccountLocalIdFromUid failed, error: " + JSON.stringify(err));
  } else {
    console.log("getOsAccountLocalIdFromUid successfully, localId: " + localId);
  }
});

getOsAccountLocalIdFromUid^(deprecated)

getOsAccountLocalIdFromUid(uid: number): Promise<number>

Obtains the OS account ID based on the process UID. This API uses a promise to return the result.

NOTE

This API is supported since API version 7 and deprecated since API version 9. You are advised to use getOsAccountLocalIdForUid.

System capability: SystemCapability.Account.OsAccount

Parameters

Return value

Example: Obtain the ID of the OS account whose process UID is 12345678.

let accountManager = account_osAccount.getAccountManager();
let uid = 12345678;
accountManager.getOsAccountLocalIdFromUid(uid).then((localId) => {
  console.log("getOsAccountLocalIdFromUid successfully, localId: " + localId);
}).catch((err) => {
  console.log("getOsAccountLocalIdFromUid failed, error: "  + JSON.stringify(err));
});

getOsAccountLocalIdFromDomain^(deprecated)

getOsAccountLocalIdFromDomain(domainInfo: DomainAccountInfo, callback: AsyncCallback<number>): void

Obtains the OS account ID based on the domain account information. This API uses an asynchronous callback to return the result.

NOTE

This API is supported since API version 8 and deprecated since API version 9. You are advised to use getOsAccountLocalIdForDomain.

Required permissions: ohos.permission.MANAGE_LOCAL_ACCOUNTS

System capability: SystemCapability.Account.OsAccount

Parameters

Example

let domainInfo = {domain: 'testDomain', accountName: 'testAccountName'};
let accountManager = account_osAccount.getAccountManager();
accountManager.getOsAccountLocalIdFromDomain(domainInfo, (err, localId) => {
  if (err) {
    console.log("getOsAccountLocalIdFromDomain failed, error: " + JSON.stringify(err));
  } else {
    console.log("getOsAccountLocalIdFromDomain successfully, localId: " + localId);
  }
});

getOsAccountLocalIdFromDomain^(deprecated)

getOsAccountLocalIdFromDomain(domainInfo: DomainAccountInfo): Promise<number>

Obtains the OS account ID based on the domain account information. This API uses a promise to return the result.

NOTE

This API is supported since API version 8 and deprecated since API version 9. You are advised to use getOsAccountLocalIdForDomain.

Required permissions: ohos.permission.MANAGE_LOCAL_ACCOUNTS

System capability: SystemCapability.Account.OsAccount

Parameters

Return value

Example

let accountManager = account_osAccount.getAccountManager();
let domainInfo = {domain: 'testDomain', accountName: 'testAccountName'};
accountManager.getOsAccountLocalIdFromDomain(domainInfo).then((localId) => {
  console.log('getOsAccountLocalIdFromDomain successfully, localId: ' + localId);
}).catch((err) => {
  console.log('getOsAccountLocalIdFromDomain failed, error: '  + JSON.stringify(err));
});

getOsAccountAllConstraints^(deprecated)

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.

NOTE

This API is supported since API version 7 and deprecated since API version 9. You are advised to use getOsAccountConstraints.

Required permissions: ohos.permission.MANAGE_LOCAL_ACCOUNTS

System capability: SystemCapability.Account.OsAccount

Parameters

Example: Obtain all constraints of OS account 100.

let accountManager = account_osAccount.getAccountManager();
let localId = 100;
accountManager.getOsAccountAllConstraints(localId, (err, constraints)=>{
  console.log('getOsAccountAllConstraints err:' + JSON.stringify(err));
  console.log('getOsAccountAllConstraints:' + JSON.stringify(constraints));
});

getOsAccountAllConstraints^(deprecated)

getOsAccountAllConstraints(localId: number): Promise<Array<string>>

NOTE

This API is supported since API version 7 and deprecated since API version 9. You are advised to use getOsAccountConstraints.

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

Return value

Example: Obtain all constraints of OS account 100.

let accountManager = account_osAccount.getAccountManager();
let localId = 100;
accountManager.getOsAccountAllConstraints(localId).then((constraints) => {
  console.log('getOsAccountAllConstraints, constraints: ' + constraints);
}).catch((err) => {
  console.log('getOsAccountAllConstraints err: '  + JSON.stringify(err));
});

queryActivatedOsAccountIds^(deprecated)

queryActivatedOsAccountIds(callback: AsyncCallback<Array<number>>): void

Obtains information about all activated OS accounts. This API uses an asynchronous callback to return the result.

NOTE

This API is supported since API version 8 and deprecated since API version 9. You are advised to use getActivatedOsAccountLocalIds.

System capability: SystemCapability.Account.OsAccount

Parameters

Example

let accountManager = account_osAccount.getAccountManager();
accountManager.queryActivatedOsAccountIds((err, idArray)=>{
  console.log('queryActivatedOsAccountIds err:' + JSON.stringify(err));
  console.log('queryActivatedOsAccountIds idArray length:' + idArray.length);
  for(let i=0;i<idArray.length;i++) {
    console.info('activated os account id: ' + idArray[i]);
  }
});

queryActivatedOsAccountIds^(deprecated)

queryActivatedOsAccountIds(): Promise<Array<number>>

NOTE

This API is supported since API version 8 and deprecated since API version 9. You are advised to use getActivatedOsAccountLocalIds.

Obtains information about all activated OS accounts. This API uses a promise to return the result.

System capability: SystemCapability.Account.OsAccount

Return value

Example

let accountManager = account_osAccount.getAccountManager();
accountManager.queryActivatedOsAccountIds().then((idArray) => {
  console.log('queryActivatedOsAccountIds, idArray: ' + idArray);
}).catch((err) => {
  console.log('queryActivatedOsAccountIds err: '  + JSON.stringify(err));
});

queryCurrentOsAccount^(deprecated)

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.

NOTE

This API is supported since API version 7 and deprecated since API version 9. You are advised to use getCurrentOsAccount.

Required permissions: ohos.permission.MANAGE_LOCAL_ACCOUNTS

System capability: SystemCapability.Account.OsAccount

Parameters

Example

let accountManager = account_osAccount.getAccountManager();
accountManager.queryCurrentOsAccount((err, curAccountInfo)=>{
  console.log('queryCurrentOsAccount err:' + JSON.stringify(err));
  console.log('queryCurrentOsAccount curAccountInfo:' + JSON.stringify(curAccountInfo));
});

queryCurrentOsAccount^(deprecated)

queryCurrentOsAccount(): Promise<OsAccountInfo>

Obtains information about the OS account to which the current process belongs. This API uses a promise to return the result.

NOTE

This API is supported since API version 7 and deprecated since API version 9. You are advised to use getCurrentOsAccount.

Required permissions: ohos.permission.MANAGE_LOCAL_ACCOUNTS

System capability: SystemCapability.Account.OsAccount

Return value

Example

let accountManager = account_osAccount.getAccountManager();
accountManager.queryCurrentOsAccount().then((accountInfo) => {
  console.log('queryCurrentOsAccount, accountInfo: ' + JSON.stringify(accountInfo));
}).catch((err) => {
  console.log('queryCurrentOsAccount err: '  + JSON.stringify(err));
});

getOsAccountTypeFromProcess^(deprecated)

getOsAccountTypeFromProcess(callback: AsyncCallback<OsAccountType>): void

Obtains the type of the account to which the current process belongs. This API uses an asynchronous callback to return the result.

NOTE

This API is supported since API version 7 and deprecated since API version 9. You are advised to use getOsAccountType.

System capability: SystemCapability.Account.OsAccount

Parameters

Example

let accountManager = account_osAccount.getAccountManager();
accountManager.getOsAccountTypeFromProcess((err, accountType) => {
  console.log('getOsAccountTypeFromProcess err: ' + JSON.stringify(err));
  console.log('getOsAccountTypeFromProcess accountType: ' + accountType);
});

getOsAccountTypeFromProcess^(deprecated)

getOsAccountTypeFromProcess(): Promise<OsAccountType>

Obtains the type of the account to which the current process belongs. This API uses a promise to return the result.

NOTE

This API is supported since API version 7 and deprecated since API version 9. You are advised to use getOsAccountType.

System capability: SystemCapability.Account.OsAccount

Return value

Example

let accountManager = account_osAccount.getAccountManager();
accountManager.getOsAccountTypeFromProcess().then((accountType) => {
  console.log('getOsAccountTypeFromProcess, accountType: ' + accountType);
}).catch((err) => {
  console.log('getOsAccountTypeFromProcess err: '  + JSON.stringify(err));
});

getDistributedVirtualDeviceId^(deprecated)

getDistributedVirtualDeviceId(callback: AsyncCallback<string>): void

Obtains the ID of this distributed virtual device. This API uses an asynchronous callback to return the result.

NOTE

This API is supported since API version 7 and deprecated since API version 9. You are advised to use queryDistributedVirtualDeviceId.

Required permissions: ohos.permission.DISTRIBUTED_DATASYNC or ohos.permission.MANAGE_LOCAL_ACCOUNTS

System capability: SystemCapability.Account.OsAccount

Parameters

Example

let accountManager = account_osAccount.getAccountManager();
accountManager.getDistributedVirtualDeviceId((err, virtualID) => {
  console.log('getDistributedVirtualDeviceId err: ' + JSON.stringify(err));
  console.log('getDistributedVirtualDeviceId virtualID: ' + virtualID);
});

getDistributedVirtualDeviceId^(deprecated)

getDistributedVirtualDeviceId(): Promise<string>

Obtains the ID of this distributed virtual device. This API uses a promise to return the result.

NOTE

This API is supported since API version 7 and deprecated since API version 9. You are advised to use queryDistributedVirtualDeviceId.

Required permissions: ohos.permission.DISTRIBUTED_DATASYNC or ohos.permission.MANAGE_LOCAL_ACCOUNTS

System capability: SystemCapability.Account.OsAccount

Return value

Example

let accountManager = account_osAccount.getAccountManager();
accountManager.getDistributedVirtualDeviceId().then((virtualID) => {
  console.log('getDistributedVirtualDeviceId, virtualID: ' + virtualID);
}).catch((err) => {
  console.log('getDistributedVirtualDeviceId err: '  + JSON.stringify(err));
});

getOsAccountLocalIdBySerialNumber^(deprecated)

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.

NOTE

This API is supported since API version 8 and deprecated since API version 9. You are advised to use getOsAccountLocalIdForSerialNumber.

System capability: SystemCapability.Account.OsAccount

Parameters

Example: Obtain the ID of the OS account whose SN is 12345.

let accountManager = account_osAccount.getAccountManager();
let serialNumber = 12345;
accountManager.getOsAccountLocalIdBySerialNumber(serialNumber, (err, localId)=>{
  console.log('ger localId err:' + JSON.stringify(err));
  console.log('get localId:' + localId + ' by serialNumber: ' + serialNumber);
});

getOsAccountLocalIdBySerialNumber^(deprecated)

getOsAccountLocalIdBySerialNumber(serialNumber: number): Promise<number>

Obtains the OS account ID based on the SN. This API uses a promise to return the result.

NOTE

This API is supported since API version 8 and deprecated since API version 9. You are advised to use getOsAccountLocalIdForSerialNumber.

System capability: SystemCapability.Account.OsAccount

Parameters

Return value

Example: Obtain the ID of the OS account whose SN is 12345.

let accountManager = account_osAccount.getAccountManager();
let serialNumber = 12345;
accountManager.getOsAccountLocalIdBySerialNumber(serialNumber).then((localId) => {
  console.log('getOsAccountLocalIdBySerialNumber localId: ' + localId);
}).catch((err) => {
  console.log('getOsAccountLocalIdBySerialNumber err: '  + JSON.stringify(err));
});

getSerialNumberByOsAccountLocalId^(deprecated)

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.

NOTE

This API is supported since API version 8 and deprecated since API version 9. You are advised to use getSerialNumberForOsAccountLocalId.

System capability: SystemCapability.Account.OsAccount

Parameters

Example: Obtain the SN of the OS account 100.

let accountManager = account_osAccount.getAccountManager();
let localId = 100;
accountManager.getSerialNumberByOsAccountLocalId(localId, (err, serialNumber)=>{
  console.log('ger serialNumber err:' + JSON.stringify(err));
  console.log('get serialNumber:' + serialNumber + ' by localId: ' + localId);
});

getSerialNumberByOsAccountLocalId^(deprecated)

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.

NOTE

This API is supported since API version 8 and deprecated since API version 9. You are advised to use getSerialNumberForOsAccountLocalId.

System capability: SystemCapability.Account.OsAccount

Parameters

Return value

Example: Obtain the SN of the OS account 100.

let accountManager = account_osAccount.getAccountManager();
let localId = 100;
accountManager.getSerialNumberByOsAccountLocalId(localId).then((serialNumber) => {
  console.log('getSerialNumberByOsAccountLocalId serialNumber: ' + serialNumber);
}).catch((err) => {
  console.log('getSerialNumberByOsAccountLocalId err: '  + JSON.stringify(err));
});

UserAuth⁸⁺

Provides APIs for user authentication.

System API: This is a system API.

constructor⁸⁺

constructor()

A constructor used to create an instance for user authentication.

System API: This is a system API.

System capability: SystemCapability.Account.OsAccount

Example

let userAuth = new account_osAccount.UserAuth();

getVersion⁸⁺

getVersion(): number;

Obtains version information.

System API: This is a system API.

System capability: SystemCapability.Account.OsAccount

Return value

Example

let userAuth = new account_osAccount.UserAuth();
let version = userAuth.getVersion();
console.log('getVersion version = ' + version);

getAvailableStatus⁸⁺

getAvailableStatus(authType: AuthType, authTrustLevel: AuthTrustLevel): number;

Obtains the available status of the authentication capability corresponding to the specified authentication type and trust level.

System API: This is a system API.

System capability: SystemCapability.Account.OsAccount

Required permissions: ohos.permission.ACCESS_USER_AUTH_INTERNAL

Parameters

Return value

Error codes

Example

let userAuth = new account_osAccount.UserAuth();
let authType = account_osAccount.AuthType.PIN;
let authTrustLevel = account_osAccount.AuthTrustLevel.ATL1;
try {
  let status = userAuth.getAvailableStatus(authType, authTrustLevel);
  console.log('getAvailableStatus status = ' + status);
} catch (e) {
  console.log('getAvailableStatus exception = ' + JSON.stringify(e));
}

getProperty⁸⁺

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.

System API: This is a system API.

System capability: SystemCapability.Account.OsAccount

Required permissions: ohos.permission.ACCESS_USER_AUTH_INTERNAL

Parameters

Error codes

Example

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
};
try {
  userAuth.getProperty(request, (err, result) => {
    console.log('getProperty err = ' + JSON.stringify(err));
    console.log('getProperty result = ' + JSON.stringify(result));
  });
} catch (e) {
  console.log('getProperty exception = ' + JSON.stringify(e));
}

getProperty⁸⁺

getProperty(request: GetPropertyRequest): Promise<ExecutorProperty>;

Obtains the executor property based on the request. This API uses a promise to return the result.

System API: This is a system API.

System capability: SystemCapability.Account.OsAccount

Required permissions: ohos.permission.ACCESS_USER_AUTH_INTERNAL

Parameters

Return value

Error codes

Example

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
};
try {
  userAuth.getProperty(request).then((result) => {
    console.log('getProperty result = ' + JSON.stringify(result));
  }).catch((err) => {
    console.log('getProperty error = ' + JSON.stringify(err));
  });
} catch (e) {
  console.log('getProperty exception = ' + JSON.stringify(e));
}

setProperty⁸⁺

setProperty(request: SetPropertyRequest, callback: AsyncCallback<void>): void;

Sets the property for the initialization algorithm. This API uses an asynchronous callback to return the result.

System API: This is a system API.

System capability: SystemCapability.Account.OsAccount

Required permissions: ohos.permission.ACCESS_USER_AUTH_INTERNAL

Parameters

Error codes

Example

let userAuth = new account_osAccount.UserAuth();
let request = {
  authType: account_osAccount.AuthType.PIN,
  key: account_osAccount.SetPropertyType.INIT_ALGORITHM,
  setInfo: new Uint8Array([0])
};
try {
  userAuth.setProperty(request, (err) => {
    if (err) {
      console.log('setProperty failed, error = ' + JSON.stringify(err));
    } else {
      console.log('setProperty successfully');
    }
  });
} catch (e) {
  console.log('setProperty exception = ' + JSON.stringify(e));
}

setProperty⁸⁺

setProperty(request: SetPropertyRequest): Promise<void>;

Sets the property for the initialization algorithm. This API uses a promise to return the result.

System API: This is a system API.

System capability: SystemCapability.Account.OsAccount

Required permissions: ohos.permission.ACCESS_USER_AUTH_INTERNAL

Parameters

Return value

Error codes

Example

let userAuth = new account_osAccount.UserAuth();
let request = {
  authType: account_osAccount.AuthType.PIN,
  key: account_osAccount.SetPropertyType.INIT_ALGORITHM,
  setInfo: new Uint8Array([0])
};
try {
  userAuth.setProperty(request).then(() => {
    console.log('setProperty successfully');
  }).catch((err) => {
    console.log('setProperty failed, error = ' + JSON.stringify(err));
  });
} catch (e) {
  console.log('setProperty exception = ' + JSON.stringify(e));
}

auth⁸⁺

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

Performs authentication of the current user. This API uses an asynchronous callback to return the result.

System API: This is a system API.

System capability: SystemCapability.Account.OsAccount

Required permissions: ohos.permission.ACCESS_USER_AUTH_INTERNAL

Parameters

Return value

Error codes

Example

let userAuth = new account_osAccount.UserAuth();
let challenge = new Uint8Array([0]);
let authType = account_osAccount.AuthType.PIN;
let authTrustLevel = account_osAccount.AuthTrustLevel.ATL1;
try {
  userAuth.auth(challenge, authType, authTrustLevel, {
    onResult: function(result,extraInfo){
        console.log('auth result = ' + result);
        console.log('auth extraInfo = ' + JSON.stringify(extraInfo));
    }
  });
} catch (e) {
  console.log('auth exception = ' + JSON.stringify(e));
}

authUser⁸⁺

authUser(userId: number, challenge: Uint8Array, authType: AuthType, authTrustLevel: AuthTrustLevel, callback: IUserAuthCallback): Uint8Array;

Performs authentication of the specified user. This API uses an asynchronous callback to return the result.

System API: This is a system API.

System capability: SystemCapability.Account.OsAccount

Required permissions: ohos.permission.ACCESS_USER_AUTH_INTERNAL

Parameters

Return value

Error codes

Example

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;
try {
  userAuth.authUser(userID, challenge, authType, authTrustLevel, {
    onResult: function(result,extraInfo){
      console.log('authUser result = ' + result);
      console.log('authUser extraInfo = ' + JSON.stringify(extraInfo));
    }
  });
} catch (e) {
  console.log('authUser exception = ' + JSON.stringify(e));
}

cancelAuth⁸⁺

cancelAuth(contextID: Uint8Array): void;

Cancels an authentication.

System API: This is a system API.

System capability: SystemCapability.Account.OsAccount

Required permissions: ohos.permission.ACCESS_USER_AUTH_INTERNAL

Parameters

Error codes

Example

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));
  }
});
try {
  userAuth.cancelAuth(contextId);
} catch (e) {
  console.log('cancelAuth exception = ' + JSON.stringify(e));
}

PINAuth⁸⁺

Provides APIs for PIN authentication.

System API: This is a system API.

constructor⁸⁺

constructor()

A constructor used to create an instance for PIN authentication.

System API: This is a system API.

System capability: SystemCapability.Account.OsAccount

Example

let pinAuth = new account_osAccount.PINAuth();

registerInputer⁸⁺

registerInputer(inputer: IInputer): void;

Register a PIN inputer.

System API: This is a system API.

System capability: SystemCapability.Account.OsAccount

Required permissions: ohos.permission.ACCESS_PIN_AUTH

Parameters

Return value

Error codes

Example

let pinAuth = new account_osAccount.PINAuth();
let password = new Uint8Array([0, 0, 0, 0, 0]);
try {
  let result = pinAuth.registerInputer({
      onGetData: (pinSubType, callback) => {
        callback.onSetData(pinSubType, password);
      }
  });
  console.log('registerInputer result = ' + result);
} catch (e) {
  console.log('registerInputer exception = ' + JSON.stringify(e));
}

unregisterInputer⁸⁺

unregisterInputer(): void;

Unregisters this PIN inputer.

System API: This is a system API.

System capability: SystemCapability.Account.OsAccount

Required permissions: ohos.permission.ACCESS_PIN_AUTH

Example

let pinAuth = new account_osAccount.PINAuth();
pinAuth.unregisterInputer();

DomainPlugin⁹⁺

Provides APIs for domain account authentication.

System API: This is a system API.

auth⁹⁺

auth(domainAccountInfo: DomainAccountInfo, credential: Uint8Array, callback: IUserAuthCallback): void

Authenticates a domain account.

System API: This is a system API.

System capability: SystemCapability.Account.OsAccount

Parameters

Example

let plugin = {
  auth: (domainAccountInfo, credential, callback) => {
    // mock authentication
    // notify authentication result
    callback.onResult(0, {
      token: new Uint8Array([0]),
      remainTimes: 5,
      freezingTime: 0
    });
  }
}
account_osAccount.DomainAccountManager.registerPlugin(plugin);
let userAuth = new account_osAccount.UserAuth();
let challenge = new Uint8Array([0]);
let authType = account_osAccount.AuthType.DOMAIN;
let authTrustLevel = account_osAccount.AuthTrustLevel.ATL1;
try {
  userAuth.auth(challenge, authType, authTrustLevel, {
    onResult: (resultCode, authResult) => {
        console.log('auth resultCode = ' + resultCode);
        console.log('auth authResult = ' + JSON.stringify(authResult));
    }
  });
} catch (err) {
  console.log('auth exception = ' + JSON.stringify(err));
}

DomainAccountManager ⁹⁺

Provides APIs for domain account management.

registerPlugin⁹⁺

static registerPlugin(plugin: DomainPlugin): void

Registers a domain plug-in.

System API: This is a system API.

System capability: SystemCapability.Account.OsAccount

Required permissions: ohos.permission.MANAGE_LOCAL_ACCOUNTS

Parameters

Error codes

Example

let plugin = {
  auth: (domainAccountInfo, credential, callback) => {}
}
try {
  account_osAccount.DomainAccountManager.registerPlugin(plugin);
  console.log('registerPlugin success.');
} catch(err) {
  console.log("registerPlugin err:" + JSON.stringify(err));
}

unregisterPlugin⁹⁺

static unregisterPlugin(): void

Unregisters this domain plug-in.

System API: This is a system API.

System capability: SystemCapability.Account.OsAccount

Required permissions: ohos.permission.MANAGE_LOCAL_ACCOUNTS

Example

try {
  account_osAccount.DomainAccountManager.unregisterPlugin();
  console.log('unregisterPlugin success.');
} catch(err) {
  console.log("unregisterPlugin err:" + JSON.stringify(err));
}

UserIdentityManager⁸⁺

Provides APIs for user identity management (IDM).

System API: This is a system API.

constructor⁸⁺

constructor()

A constructor used to create an instance for user IDM.

System API: This is a system API.

System capability: SystemCapability.Account.OsAccount

Example

let userIDM = new account_osAccount.UserIdentityManager();

openSession⁸⁺

openSession(callback: AsyncCallback<Uint8Array>): void;

Opens a session to obtain the challenge value. This API uses an asynchronous callback to return the result.

System API: This is a system API.

System capability: SystemCapability.Account.OsAccount

Required permissions: ohos.permission.MANAGE_USER_IDM

Parameters

Error codes

Example

let userIDM = new account_osAccount.UserIdentityManager();
try {
  userIDM.openSession((err, challenge) => {
      console.log('openSession error = ' + JSON.stringify(err));
      console.log('openSession challenge = ' + JSON.stringify(challenge));
  });
} catch (e) {
  console.log('openSession exception = ' + JSON.stringify(e));
}

openSession⁸⁺

openSession(): Promise<Uint8Array>;

Opens a session to obtain the challenge value. This API uses a promise to return the result.

System API: This is a system API.

System capability: SystemCapability.Account.OsAccount

Required permissions: ohos.permission.MANAGE_USER_IDM

Return value

Error codes

Example

let userIDM = new account_osAccount.UserIdentityManager();
try {
  userIDM.openSession().then((challenge) => {
      console.info('openSession challenge = ' + JSON.stringify(challenge));
  }).catch((err) => {
      console.info('openSession error = ' + JSON.stringify(err));
  });
} catch (e) {
  console.log('openSession exception = ' + JSON.stringify(e));
}

addCredential⁸⁺

addCredential(credentialInfo: CredentialInfo, callback: IIdmCallback): void;

Adds credential information, including the credential type, subtype, and token (if a non-PIN credential is added).

System API: This is a system API.

System capability: SystemCapability.Account.OsAccount

Required permissions: ohos.permission.MANAGE_USER_IDM

Parameters

Error codes

Example

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) => {
  try {
  userIDM.addCredential(credentialInfo, {
    onResult: (result, extraInfo) => {
      console.log('updateCredential result = ' + result);
      console.log('updateCredential extraInfo = ' + extraInfo);
    }
  });
  } catch (e) {
    console.log('updateCredential exception = ' + JSON.stringify(e));
  }
});

updateCredential⁸⁺

updateCredential(credentialInfo: CredentialInfo, callback: IIdmCallback): void;

Updates credential information. This API uses a callback to return the result.

System API: This is a system API.

System capability: SystemCapability.Account.OsAccount

Required permissions: ohos.permission.MANAGE_USER_IDM

Parameters