文档管理中心

@ohos.enterprise.securityManager(安全管理)

Phone12+PC/2in113+Tablet12+
本文导读
展开章节

本模块提供企业设备安全管理能力,支持证书管理、设备安全策略管理、口令策略管理、剪贴板策略管理、水印策略管理、权限管理等功能。企业可使用本模块实现设备安全状态的实时监控、企业证书的生命周期管理、设备口令策略的统一配置、应用剪贴板使用行为的管控、屏幕和应用水印的设置以防止信息泄露、以及应用权限的精细化管理等场景,帮助企业提升设备安全防护能力,降低数据泄露风险。

说明

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

本模块接口仅可在Stage模型下使用。

本模块接口仅对设备管理应用开放,且调用接口前需激活设备管理应用,具体请参考MDM Kit开发指南

导入模块

收起
自动换行
深色代码主题
复制
  1. import { securityManager } from '@kit.MDMKit';

securityManager.uninstallUserCertificate

Phone12+PC/2in113+Tablet12+

uninstallUserCertificate(admin: Want, certUri: string): Promise<void>

卸载用户证书,使用Promise异步回调。适用于企业证书管理场景,如证书过期更换、撤销员工对企业资源的访问权限等。企业可在证书过期、更换或不再需要时调用此接口卸载证书,确保设备证书管理的灵活性和安全性。

需要权限: ohos.permission.ENTERPRISE_MANAGE_CERTIFICATE

系统能力: SystemCapability.Customization.EnterpriseDeviceManager

模型约束: 此接口仅可在Stage模型下使用。

参数:

展开
参数名 类型 必填 说明
admin Want 企业设备管理扩展组件。Want中必须包含企业设备管理扩展能力的abilityName和所在应用的bundleName。
certUri string 证书uri,由安装用户证书接口installUserCertificate设置返回。

返回值:

展开
类型 说明
Promise<void> 无返回结果的Promise对象。当卸载用户证书失败时会抛出错误对象。

错误码

以下错误码的详细介绍请参见企业设备管理错误码通用错误码

展开
错误码ID 错误信息
9200001 The application is not an administrator application of the device.
9200002 The administrator application does not have permission to manage the device.
9201001 Failed to manage the certificate.
201 Permission verification failed. The application does not have the permission required to call the API.
401 Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed.

示例:

收起
自动换行
深色代码主题
复制
  1. import { securityManager } from '@kit.MDMKit';
  2. import { Want } from '@kit.AbilityKit';
  3. import { BusinessError } from '@kit.BasicServicesKit';
  4. let wantTemp: Want = {
  5. // 需根据实际情况进行替换
  6. bundleName: 'com.example.myapplication',
  7. abilityName: 'EnterpriseAdminAbility'
  8. };
  9. // 需根据实际情况进行替换
  10. let aliasStr = "certName";
  11. securityManager.uninstallUserCertificate(wantTemp, aliasStr).then(() => {
  12. console.info(`Succeeded in uninstalling user certificate.`);
  13. }).catch((err: BusinessError) => {
  14. console.error(`Failed to uninstall user certificate. Code is ${err.code}, message is ${err.message}`);
  15. });

securityManager.installUserCertificate

Phone12+PC/2in113+Tablet12+

installUserCertificate(admin: Want, certificate: CertBlob): Promise<string>

安装用户证书,使用Promise异步回调。企业可通过此接口将证书安装到设备上,用于企业VPN连接、安全认证、数字签名等场景,实现企业级的安全通信和数据保护。

需要权限: ohos.permission.ENTERPRISE_MANAGE_CERTIFICATE

系统能力: SystemCapability.Customization.EnterpriseDeviceManager

模型约束: 此接口仅可在Stage模型下使用。

参数:

展开
参数名 类型 必填 说明
admin Want 企业设备管理扩展组件。Want中必须包含企业设备管理扩展能力的abilityName和所在应用的bundleName。
certificate CertBlob 证书信息。证书文件应放在应用沙箱路径(应用沙箱路径和真实路径的对应关系可参见:应用沙箱路径和真实物理路径的对应关系)等应用有权限访问的路径下。

返回值:

展开
类型 说明
Promise<string> Promise对象,返回当前证书安装后的uri,用于卸载证书。

错误码

以下错误码的详细介绍请参见企业设备管理错误码通用错误码

展开
错误码ID 错误信息
9200001 The application is not an administrator application of the device.
9200002 The administrator application does not have permission to manage the device.
9201001 Failed to manage the certificate.
201 Permission verification failed. The application does not have the permission required to call the API.
401 Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed.

示例:

收起
自动换行
深色代码主题
复制
  1. import { securityManager } from '@kit.MDMKit';
  2. import { common, Want } from '@kit.AbilityKit';
  3. import { BusinessError } from '@kit.BasicServicesKit';
  4. let wantTemp: Want = {
  5. // 需根据实际情况进行替换
  6. bundleName: 'com.example.myapplication',
  7. abilityName: 'EnterpriseAdminAbility'
  8. };
  9. let certFileArray: Uint8Array = new Uint8Array();
  10. // 变量context需要在MainAbility的onCreate回调函数中进行初始化
  11. // test.cer需要放置在rawfile目录下
  12. // 请在组件内获取context,确保this.getUIContext().getHostContext()返回结果为UIAbilityContext
  13. const context = this.getUIContext().getHostContext() as common.UIAbilityContext;
  14. context.resourceManager.getRawFileContent("test.cer").then((value) => {
  15. certFileArray = value;
  16. securityManager.installUserCertificate(wantTemp, { inData: certFileArray, alias: "cert_alias_xts" })
  17. .then((result) => {
  18. console.info(`Succeeded in installing user certificate, result : ${JSON.stringify(result)}`);
  19. }).catch((err: BusinessError) => {
  20. console.error(`Failed to install user certificate. Code: ${err.code}, message: ${err.message}`);
  21. });
  22. }).catch((err: BusinessError) => {
  23. console.error(`Failed to get raw file content. message: ${err.message}`);
  24. return;
  25. });

securityManager.installUserCertificate18+

Phone18+PC/2in118+Tablet18+

installUserCertificate(admin: Want, certificate: CertBlob, accountId: number): string

支持按系统账户安装用户证书。企业可为不同用户账户安装独立的证书,实现多用户环境下的安全隔离和个性化证书管理,满足多用户设备的安全管控需求。

需要权限: ohos.permission.ENTERPRISE_MANAGE_CERTIFICATE

系统能力: SystemCapability.Customization.EnterpriseDeviceManager

模型约束: 此接口仅可在Stage模型下使用。

参数:

展开
参数名 类型 必填 说明
admin Want 企业设备管理扩展组件。Want中必须包含企业设备管理扩展能力的abilityName和所在应用的bundleName。
certificate CertBlob 证书信息。证书文件应放在应用沙箱路径(应用沙箱路径和真实路径的对应关系可参见:应用沙箱路径和真实物理路径的对应关系)等应用有权限访问的路径下。
accountId number 用户ID,指定具体用户,取值范围:大于等于0。accountId可以通过@ohos.account.osAccount中的getOsAccountLocalId等接口来获取。

返回值:

展开
类型 说明
string 返回当前证书安装后的uri,用于卸载证书。

错误码

以下错误码的详细介绍请参见企业设备管理错误码通用错误码

展开
错误码ID 错误信息
9200001 The application is not an administrator application of the device.
9200002 The administrator application does not have permission to manage the device.
9201001 Failed to manage the certificate.
201 Permission verification failed. The application does not have the permission required to call the API.

示例:

收起
自动换行
深色代码主题
复制
  1. import { securityManager } from '@kit.MDMKit';
  2. import { common, Want } from '@kit.AbilityKit';
  3. let wantTemp: Want = {
  4. // 需根据实际情况进行替换
  5. bundleName: 'com.example.myapplication',
  6. abilityName: 'EnterpriseAdminAbility'
  7. };
  8. let certFileArray: Uint8Array = new Uint8Array();
  9. let accountId: number = 100;
  10. // 变量context需要在MainAbility的onCreate回调函数中进行初始化
  11. // test.cer需要放置在rawfile目录下
  12. // 请在组件内获取context,确保this.getUIContext().getHostContext()返回结果为UIAbilityContext
  13. const context = this.getUIContext().getHostContext() as common.UIAbilityContext;
  14. context.resourceManager.getRawFileContent("test.cer").then((value) => {
  15. certFileArray = value;
  16. try {
  17. let result: string = securityManager.installUserCertificate(wantTemp, { inData: certFileArray, alias: "cert_alias_xts" }, accountId);
  18. console.info(`Succeeded in installing user certificate. result: ${result}`);
  19. } catch (err) {
  20. console.error(`Failed to install user certificate. Code: ${err.code}, message: ${err.message}`);
  21. }
  22. });

securityManager.getUserCertificates18+

Phone18+PC/2in118+Tablet18+

getUserCertificates(admin: Want, accountId: number): Array<string>

获取指定系统账户下的用户证书信息。企业可通过此接口查询设备上已安装的用户证书列表,用于证书审计、证书有效期管理等场景,确保证书管理的可追溯性。

需要权限: ohos.permission.ENTERPRISE_MANAGE_CERTIFICATE

系统能力: SystemCapability.Customization.EnterpriseDeviceManager

模型约束: 此接口仅可在Stage模型下使用。

参数:

展开
参数名 类型 必填 说明
admin Want 企业设备管理扩展组件。Want中必须包含企业设备管理扩展能力的abilityName和所在应用的bundleName。
accountId number 用户ID,指定具体用户,取值范围:大于等于0。accountId可以通过@ohos.account.osAccount中的getOsAccountLocalId等接口来获取。

返回值:

展开
类型 说明
Array<string> 返回在指定用户ID下安装的所有用户证书。

错误码

以下错误码的详细介绍请参见企业设备管理错误码通用错误码

展开
错误码ID 错误信息
9200001 The application is not an administrator application of the device.
9200002 The administrator application does not have permission to manage the device.
201 Permission verification failed. The application does not have the permission required to call the API.

示例:

收起
自动换行
深色代码主题
复制
  1. import { securityManager } from '@kit.MDMKit';
  2. import { Want } from '@kit.AbilityKit';
  3. let wantTemp: Want = {
  4. // 需根据实际情况进行替换
  5. bundleName: 'com.example.myapplication',
  6. abilityName: 'EnterpriseAdminAbility'
  7. };
  8. // 需根据实际情况进行替换
  9. let accountId: number = 100;
  10. try {
  11. let result: Array<string> = securityManager.getUserCertificates(wantTemp, accountId);
  12. console.info(`Succeeded in getting the uri list of user Certificates. result: ${JSON.stringify(result)}`);
  13. } catch (err) {
  14. console.error(`Failed to get the uri list of user Certificates. Code: ${err.code}, message: ${err.message}`);
  15. }

securityManager.getSecurityStatus

Phone12+PC/2in113+Tablet12+

getSecurityStatus(admin: Want, item: string): string

获取当前设备安全策略信息。适用于设备合规性检查、安全状态审计、策略执行效果验证等场景,帮助企业管理员确认设备是否符合安全要求。企业可通过此接口实时监控设备的安全补丁状态和文件加密状态,及时发现设备安全风险并采取相应措施,保障企业设备和数据安全。

需要权限: ohos.permission.ENTERPRISE_MANAGE_SECURITY

系统能力: SystemCapability.Customization.EnterpriseDeviceManager

模型约束: 此接口仅可在Stage模型下使用。

参数:

展开
参数名 类型 必填 说明
admin Want 企业设备管理扩展组件。Want中必须包含企业设备管理扩展能力的abilityName和所在应用的bundleName。
item string

安全策略名称。

- patch:设备安全补丁。

- encryption:设备文件系统加密。

- root:设备ROOT状态。

- fastboot24+:设备fastboot模式锁定状态。

返回值:

展开
类型 说明
string 返回安全策略状态值。

错误码

以下错误码的详细介绍请参见企业设备管理错误码通用错误码

展开
错误码ID 错误信息
9200001 The application is not an administrator application of the device.
9200002 The administrator application does not have permission to manage the device.
201 Permission verification failed. The application does not have the permission required to call the API.
401 Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed.

示例:

收起
自动换行
深色代码主题
复制
  1. import { securityManager } from '@kit.MDMKit';
  2. import { Want } from '@kit.AbilityKit';
  3. let wantTemp: Want = {
  4. // 需根据实际情况进行替换
  5. bundleName: 'com.example.myapplication',
  6. abilityName: 'EnterpriseAdminAbility'
  7. };
  8. try {
  9. let result: string = securityManager.getSecurityStatus(wantTemp, 'patch');
  10. console.info(`Succeeded in getting security patch tag. tag: ${result}`);
  11. } catch (err) {
  12. console.error(`Failed to get security patch tag. Code: ${err.code}, message: ${err.message}`);
  13. }

securityManager.setPasswordPolicy

Phone12+PC/2in113+Tablet12+

setPasswordPolicy(admin: Want, policy: PasswordPolicy): void

设置设备锁屏口令策略。策略设置后,当用户设置锁屏口令时,如果设置的锁屏口令不符合要求,会有安全提示重新设置锁屏口令。适用于企业安全合规场景,如强制要求员工使用强密码、定期更换密码等,降低企业数据泄露风险。

需要权限: ohos.permission.ENTERPRISE_MANAGE_SECURITY

系统能力: SystemCapability.Customization.EnterpriseDeviceManager

模型约束: 此接口仅可在Stage模型下使用。

冲突规则: 配置

参数:

展开
参数名 类型 必填 说明
admin Want 企业设备管理扩展组件。Want中必须包含企业设备管理扩展能力的abilityName和所在应用的bundleName。
policy PasswordPolicy 设备锁屏口令策略。

错误码

以下错误码的详细介绍请参见企业设备管理错误码通用错误码

展开
错误码ID 错误信息
9200001 The application is not an administrator application of the device.
9200002 The administrator application does not have permission to manage the device.
9200007 The system ability works abnormally.
201 Permission verification failed. The application does not have the permission required to call the API.
401 Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed.

示例:

收起
自动换行
深色代码主题
复制
  1. import { securityManager } from '@kit.MDMKit';
  2. import { Want } from '@kit.AbilityKit';
  3. let wantTemp: Want = {
  4. // 需根据实际情况进行替换
  5. bundleName: 'com.example.myapplication',
  6. abilityName: 'EnterpriseAdminAbility'
  7. };
  8. let policy: securityManager.PasswordPolicy = {
  9. complexityRegex: '^(?=.*[a-z])(?=.*[A-Z])(?=.*\\d)(?=.*[!@#$%^&*])[a-zA-Z\\d!@#$%^&*]{8,}$',
  10. validityPeriod: 1,
  11. additionalDescription: '至少八个字符,至少一个大写字母,一个小写字母,一个数字和一个特殊字符',
  12. passwordAlgs: securityManager.PasswordAlgs.SCRYPT_HKDF_SM4
  13. };
  14. try {
  15. securityManager.setPasswordPolicy(wantTemp, policy);
  16. console.info(`Succeeded in setting password policy.`);
  17. } catch (err) {
  18. console.error(`Failed to set password policy. Code: ${err.code}, message: ${err.message}`);
  19. }

securityManager.getPasswordPolicy

Phone12+PC/2in113+Tablet12+

getPasswordPolicy(admin: Want): PasswordPolicy

获取设备锁屏口令策略。企业可通过此接口查询当前配置的口令策略,用于策略审计、合规性检查等场景,确保设备口令策略符合企业安全规范。

本接口通过传入Want查询对应企业设备管理应用设置的策略,如需查询实际生效的策略,请使用securityManager.getPasswordPolicy接口。

需要权限: ohos.permission.ENTERPRISE_MANAGE_SECURITY

系统能力: SystemCapability.Customization.EnterpriseDeviceManager

模型约束: 此接口仅可在Stage模型下使用。

参数:

展开
参数名 类型 必填 说明
admin Want 企业设备管理扩展组件。Want中必须包含企业设备管理扩展能力的abilityName和所在应用的bundleName。

返回值:

展开
类型 说明
PasswordPolicy 设备锁屏口令策略。

错误码

以下错误码的详细介绍请参见企业设备管理错误码通用错误码

展开
错误码ID 错误信息
9200001 The application is not an administrator application of the device.
9200002 The administrator application does not have permission to manage the device.
201 Permission verification failed. The application does not have the permission required to call the API.
401 Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed.

示例:

收起
自动换行
深色代码主题
复制
  1. import { securityManager } from '@kit.MDMKit';
  2. import { Want } from '@kit.AbilityKit';
  3. let wantTemp: Want = {
  4. // 需根据实际情况进行替换
  5. bundleName: 'com.example.myapplication',
  6. abilityName: 'EnterpriseAdminAbility'
  7. };
  8. try {
  9. let result: securityManager.PasswordPolicy = securityManager.getPasswordPolicy(wantTemp);
  10. console.info(`Succeeded in getting password policy, result : ${JSON.stringify(result)}`);
  11. } catch (err) {
  12. console.error(`Failed to get password policy. Code: ${err.code}, message: ${err.message}`);
  13. }

securityManager.getPasswordPolicy

Phone26.0.0+PC/2in126.0.0+Tablet26.0.0+

getPasswordPolicy(admin: Want | null): PasswordPolicy

获取设备锁屏口令策略。企业可通过此接口查询当前配置的口令策略,用于策略审计、合规性检查等场景,确保设备口令策略符合企业安全规范。

起始版本: 26.0.0

需要权限: ohos.permission.ENTERPRISE_MANAGE_SECURITY

系统能力: SystemCapability.Customization.EnterpriseDeviceManager

模型约束: 此接口仅可在Stage模型下使用。

参数:

展开
参数名 类型 必填 说明
admin Want | null

企业设备管理扩展组件。Want中必须包含企业设备管理扩展能力的abilityName和所在应用的bundleName。

当设备存在多个MDM应用时,传入Want时查询对应企业设备管理应用设置的策略,传入null时查询实际生效的策略。

返回值:

展开
类型 说明
PasswordPolicy 设备锁屏口令策略。

错误码

以下错误码的详细介绍请参见企业设备管理错误码通用错误码

展开
错误码ID 错误信息
9200001 The application is not an administrator application of the device.
9200002 The administrator application does not have permission to manage the device.
201 Permission verification failed. The application does not have the permission required to call the API.
401 Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed.

示例:

收起
自动换行
深色代码主题
复制
  1. import { securityManager } from '@kit.MDMKit';
  2. try {
  3. // 参数需根据实际情况进行替换
  4. let result: securityManager.PasswordPolicy = securityManager.getPasswordPolicy(null);
  5. console.info(`Succeeded in getting password policy, result : ${JSON.stringify(result)}`);
  6. } catch (err) {
  7. console.error(`Failed to get password policy. Code: ${err.code}, message: ${err.message}`);
  8. }

securityManager.setScreenLockDisabledForAccount

Phone26.0.0+Tablet26.0.0+

setScreenLockDisabledForAccount(admin: Want, disable: boolean): void

禁用/启用当前用户的滑动解锁能力。启用时:设备灭屏后再亮屏,用户需要在屏幕上滑动后才能进入桌面。禁用时:设备灭屏后再亮屏会直接进入桌面。适用于企业设备管理场景,如在特定安全环境下禁用滑动解锁简化操作,或在通用场景下启用滑动解锁作为基础安全措施。

说明

1.该接口能力仅在设备无锁屏密码时生效。

2.设备默认属于启用滑动解锁的状态。

3.设备上存在密码时,设置禁用滑动解锁会失败,抛出9201021错误码。

4.下发禁用滑动解锁的策略后,用户输入了设备密码,此时密码会生效,设备需要验证密码后才能进入桌面,之前下发的策略失效。

起始版本: 26.0.0

需要权限: ohos.permission.ENTERPRISE_MANAGE_SECURITY

系统能力: SystemCapability.Customization.EnterpriseDeviceManager

模型约束: 此接口仅可在Stage模型下使用。

设备行为差异: 该接口在Phone和Tablet中可正常调用,在其他设备中调用返回801错误码。

冲突规则: 配置

参数:

展开
参数名 类型 必填 说明
admin Want 企业设备管理扩展组件。Want中必须包含企业设备管理扩展能力的abilityName和所在应用的bundleName。
disable boolean 是否禁用当前用户的滑动解锁能力。true表示禁用,false表示不禁用。

错误码

以下错误码的详细介绍请参见企业设备管理错误码通用错误码

展开
错误码ID 错误信息
9200001 The application is not an administrator application of the device.
9200002 The administrator application does not have permission to manage the device.
9201021 A lock screen password has been set for the device.
201 Permission verification failed. The application does not have the permission required to call the API.
801 Capability not supported. Failed to call the API due to limited device capabilities.

示例:

收起
自动换行
深色代码主题
复制
  1. import { securityManager } from '@kit.MDMKit';
  2. import { Want } from '@kit.AbilityKit';
  3. let wantTemp: Want = {
  4. // 需根据实际情况进行替换
  5. bundleName: 'com.example.myapplication',
  6. abilityName: 'EnterpriseAdminAbility'
  7. };
  8. try {
  9. securityManager.setScreenLockDisabledForAccount(wantTemp, true);
  10. console.info(`Succeeded in setting screen lock disabled for account.`);
  11. } catch (err) {
  12. console.error(`Failed to set screen lock disabled for account. Code: ${err.code}, message: ${err.message}`);
  13. }

securityManager.isScreenLockDisabledForAccount

Phone26.0.0+Tablet26.0.0+

isScreenLockDisabledForAccount(admin: Want): boolean

查询当前用户的滑动解锁能力是否被禁用。

起始版本: 26.0.0

需要权限: ohos.permission.ENTERPRISE_MANAGE_SECURITY

系统能力: SystemCapability.Customization.EnterpriseDeviceManager

模型约束: 此接口仅可在Stage模型下使用。

设备行为差异: 该接口在Phone和Tablet中可正常调用,在其他设备中调用返回801错误码。

参数:

展开
参数名 类型 必填 说明
admin Want 企业设备管理扩展组件。Want中必须包含企业设备管理扩展能力的abilityName和所在应用的bundleName。

返回值:

展开
类型 说明
boolean 返回true表示当前用户的滑动解锁能力已禁用,false表示未禁用。

错误码

以下错误码的详细介绍请参见企业设备管理错误码通用错误码

展开
错误码ID 错误信息
9200001 The application is not an administrator application of the device.
9200002 The administrator application does not have permission to manage the device.
201 Permission verification failed. The application does not have the permission required to call the API.
801 Capability not supported. Failed to call the API due to limited device capabilities.

示例:

收起
自动换行
深色代码主题
复制
  1. import { securityManager } from '@kit.MDMKit';
  2. import { Want } from '@kit.AbilityKit';
  3. let wantTemp: Want = {
  4. // 需根据实际情况进行替换
  5. bundleName: 'com.example.myapplication',
  6. abilityName: 'EnterpriseAdminAbility'
  7. };
  8. try {
  9. let result: boolean = securityManager.isScreenLockDisabledForAccount(wantTemp);
  10. console.info(`Succeeded in checking screen lock disabled for account, result : ${result}`);
  11. } catch (err) {
  12. console.error(`Failed to check screen lock disabled for account. Code: ${err.code}, message: ${err.message}`);
  13. }

securityManager.setAppClipboardPolicy

Phone12+PC/2in113+Tablet12+

setAppClipboardPolicy(admin: Want, tokenId: number, policy: ClipboardPolicy): void

设置设备剪贴板策略。策略设置后,应用将按照设置的策略限制剪贴板的使用范围。适用于企业数据防泄露场景,如限制敏感应用(如企业邮箱、财务系统)的剪贴板使用范围,防止敏感数据被复制到非授权应用,降低数据泄露风险。企业可通过此接口控制应用的剪贴板使用权限,防止敏感数据通过剪贴板泄露到未授权应用,增强企业数据安全防护能力。

需要权限: ohos.permission.ENTERPRISE_MANAGE_SECURITY

系统能力: SystemCapability.Customization.EnterpriseDeviceManager

模型约束: 此接口仅可在Stage模型下使用。

冲突规则: 从严管控

参数:

展开
参数名 类型 必填 说明
admin Want 企业设备管理扩展组件。Want中必须包含企业设备管理扩展能力的abilityName和所在应用的bundleName。
tokenId number 目标应用的身份标识。可通过bundleManager.getApplicationInfo获取accessTokenId。
policy ClipboardPolicy 剪贴板策略。

错误码

以下错误码的详细介绍请参见企业设备管理错误码通用错误码

展开
错误码ID 错误信息
9200001 The application is not an administrator application of the device.
9200002 The administrator application does not have permission to manage the device.
201 Permission verification failed. The application does not have the permission required to call the API.
401 Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed.

示例:

收起
自动换行
深色代码主题
复制
  1. import { securityManager } from '@kit.MDMKit';
  2. import { Want } from '@kit.AbilityKit';
  3. let wantTemp: Want = {
  4. // 需根据实际情况进行替换
  5. bundleName: 'com.example.myapplication',
  6. abilityName: 'EnterpriseAdminAbility'
  7. };
  8. // 需根据实际情况进行替换
  9. let tokenId: number = 586874394;
  10. try {
  11. securityManager.setAppClipboardPolicy(wantTemp, tokenId, securityManager.ClipboardPolicy.IN_APP);
  12. console.info(`Succeeded in setting clipboard policy.`);
  13. } catch (err) {
  14. console.error(`Failed to set clipboard policy. Code: ${err.code}, message: ${err.message}`);
  15. }

securityManager.getAppClipboardPolicy

Phone12+PC/2in113+Tablet12+

getAppClipboardPolicy(admin: Want, tokenId?: number): string

获取设备剪贴板策略。企业可通过此接口查询当前配置的剪贴板策略,用于策略审计和合规性检查,确保剪贴板管控策略符合企业安全要求。

本接口通过传入Want查询对应企业设备管理应用设置的策略,如需查询实际生效的策略,请使用securityManager.getAppClipboardPolicy接口。

需要权限: ohos.permission.ENTERPRISE_MANAGE_SECURITY

系统能力: SystemCapability.Customization.EnterpriseDeviceManager

模型约束: 此接口仅可在Stage模型下使用。

参数:

展开
参数名 类型 必填 说明
admin Want 企业设备管理扩展组件。Want中必须包含企业设备管理扩展能力的abilityName和所在应用的bundleName。
tokenId number 目标应用的身份标识。可通过bundleManager.getApplicationInfo获取accessTokenId。

返回值:

展开
类型 说明
string 返回JSON字符串形式的设备剪贴板策略。

错误码

以下错误码的详细介绍请参见企业设备管理错误码通用错误码

展开
错误码ID 错误信息
9200001 The application is not an administrator application of the device.
9200002 The administrator application does not have permission to manage the device.
201 Permission verification failed. The application does not have the permission required to call the API.
401 Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed.

示例:

收起
自动换行
深色代码主题
复制
  1. import { securityManager } from '@kit.MDMKit';
  2. import { Want } from '@kit.AbilityKit';
  3. let wantTemp: Want = {
  4. // 需根据实际情况进行替换
  5. bundleName: 'com.example.myapplication',
  6. abilityName: 'EnterpriseAdminAbility'
  7. };
  8. // 需根据实际情况进行替换
  9. let tokenId: number = 586874394;
  10. try {
  11. let result: string = securityManager.getAppClipboardPolicy(wantTemp, tokenId);
  12. console.info(`Succeeded in getting clipboard policy, result : ${result}`);
  13. } catch (err) {
  14. console.error(`Failed to get clipboard policy. Code: ${err.code}, message: ${err.message}`);
  15. }

securityManager.getAppClipboardPolicy

Phone26.0.0+PC/2in126.0.0+Tablet26.0.0+

getAppClipboardPolicy(admin: Want | null, tokenId?: number): string

获取设备剪贴板策略。企业可通过此接口查询当前配置的剪贴板策略,用于策略审计和合规性检查,确保剪贴板管控策略符合企业安全要求。

起始版本: 26.0.0

需要权限: ohos.permission.ENTERPRISE_MANAGE_SECURITY

系统能力: SystemCapability.Customization.EnterpriseDeviceManager

模型约束: 此接口仅可在Stage模型下使用。

参数:

展开
参数名 类型 必填 说明
admin Want | null

企业设备管理扩展组件。Want中必须包含企业设备管理扩展能力的abilityName和所在应用的bundleName。

当设备存在多个MDM应用时,传入Want时查询对应企业设备管理应用设置的策略,传入null时查询实际生效的策略。

tokenId number 目标应用的身份标识。可通过bundleManager.getApplicationInfo获取accessTokenId。

返回值:

展开
类型 说明
string 返回JSON字符串形式的设备剪贴板策略。

错误码

以下错误码的详细介绍请参见企业设备管理错误码通用错误码

展开
错误码ID 错误信息
9200001 The application is not an administrator application of the device.
9200002 The administrator application does not have permission to manage the device.
201 Permission verification failed. The application does not have the permission required to call the API.
401 Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed.

示例:

收起
自动换行
深色代码主题
复制
  1. import { securityManager } from '@kit.MDMKit';
  2. // 需根据实际情况进行替换
  3. let tokenId: number = 586874394;
  4. try {
  5. // 参数需根据实际情况进行替换
  6. let result: string = securityManager.getAppClipboardPolicy(null, tokenId);
  7. console.info(`Succeeded in getting clipboard policy, result : ${result}`);
  8. } catch (err) {
  9. console.error(`Failed to get clipboard policy. Code: ${err.code}, message: ${err.message}`);
  10. }

securityManager.setAppClipboardPolicy18+

Phone18+PC/2in118+Tablet18+

setAppClipboardPolicy(admin: Want, bundleName: string, accountId: number, policy: ClipboardPolicy): void

设置指定用户下指定应用的设备剪贴板策略。策略设置后,指定应用的剪贴板将按照策略限制使用范围。企业可为不同用户的不同应用配置差异化的剪贴板使用权限,实现精细化的数据访问控制,满足多用户多应用场景下的安全管控需求。

需要权限: ohos.permission.ENTERPRISE_MANAGE_SECURITY

系统能力: SystemCapability.Customization.EnterpriseDeviceManager

模型约束: 此接口仅可在Stage模型下使用。

冲突规则: 从严管控

参数:

展开
参数名 类型 必填 说明
admin Want 企业设备管理扩展组件。Want中必须包含企业设备管理扩展能力的abilityName和所在应用的bundleName。
bundleName string 被设置剪贴板策略的应用包名。
accountId number 用户ID,指定具体用户,取值范围:大于等于0。accountId可以通过@ohos.account.osAccount中的getOsAccountLocalId等接口来获取。
policy ClipboardPolicy 剪贴板策略。

错误码

以下错误码的详细介绍请参见企业设备管理错误码通用错误码

展开
错误码ID 错误信息
9200001 The application is not an administrator application of the device.
9200002 The administrator application does not have permission to manage the device.
201 Permission verification failed. The application does not have the permission required to call the API.

示例:

收起
自动换行
深色代码主题
复制
  1. import { securityManager } from '@kit.MDMKit';
  2. import { Want } from '@kit.AbilityKit';
  3. let wantTemp: Want = {
  4. // 需根据实际情况进行替换
  5. bundleName: 'com.example.myapplication',
  6. abilityName: 'EnterpriseAdminAbility'
  7. };
  8. // 需根据实际情况进行替换
  9. let bundleName: string = 'com.example.myapplication';
  10. let accountId: number = 100;
  11. try {
  12. securityManager.setAppClipboardPolicy(wantTemp, bundleName, accountId, securityManager.ClipboardPolicy.IN_APP);
  13. console.info(`Succeeded in setting clipboard policy.`);
  14. } catch (err) {
  15. console.error(`Failed to set clipboard policy. Code: ${err.code}, message: ${err.message}`);
  16. }

securityManager.getAppClipboardPolicy18+

Phone18+PC/2in118+Tablet18+

getAppClipboardPolicy(admin: Want, bundleName: string, accountId: number): string

获取指定用户下指定应用的设备剪贴板策略。企业可通过此接口查询特定应用的剪贴板使用权限配置,用于策略审计和合规性检查。

本接口通过传入Want查询对应企业设备管理应用设置的策略,如需查询实际生效的策略,请使用securityManager.getAppClipboardPolicy接口。

需要权限: ohos.permission.ENTERPRISE_MANAGE_SECURITY

系统能力: SystemCapability.Customization.EnterpriseDeviceManager

模型约束: 此接口仅可在Stage模型下使用。

参数:

展开
参数名 类型 必填 说明
admin Want 企业设备管理扩展组件。Want中必须包含企业设备管理扩展能力的abilityName和所在应用的bundleName。
bundleName string 被设置剪贴板策略的应用包名。
accountId number 用户ID,指定具体用户,取值范围:大于等于0。accountId可以通过@ohos.account.osAccount中的getOsAccountLocalId等接口来获取。

返回值:

展开
类型 说明
string 返回JSON字符串形式的设备剪贴板策略。

错误码

以下错误码的详细介绍请参见企业设备管理错误码通用错误码

展开
错误码ID 错误信息
9200001 The application is not an administrator application of the device.
9200002 The administrator application does not have permission to manage the device.
201 Permission verification failed. The application does not have the permission required to call the API.

示例:

收起
自动换行
深色代码主题
复制
  1. import { securityManager } from '@kit.MDMKit';
  2. import { Want } from '@kit.AbilityKit';
  3. let wantTemp: Want = {
  4. // 需根据实际情况进行替换
  5. bundleName: 'com.example.myapplication',
  6. abilityName: 'EnterpriseAdminAbility'
  7. };
  8. // 需根据实际情况进行替换
  9. let bundleName: string = 'com.example.myapplication';
  10. let accountId: number = 100;
  11. try {
  12. let result: string = securityManager.getAppClipboardPolicy(wantTemp, bundleName, accountId);
  13. console.info(`Succeeded in getting clipboard policy, result : ${result}`);
  14. } catch (err) {
  15. console.error(`Failed to get clipboard policy. Code: ${err.code}, message: ${err.message}`);
  16. }

securityManager.getAppClipboardPolicy

Phone26.0.0+PC/2in126.0.0+Tablet26.0.0+

getAppClipboardPolicy(admin: Want | null, bundleName: string, accountId: number): string

获取指定用户下指定应用的设备剪贴板策略。企业可通过此接口查询特定应用的剪贴板使用权限配置,用于策略审计和合规性检查。

起始版本: 26.0.0

需要权限: ohos.permission.ENTERPRISE_MANAGE_SECURITY

系统能力: SystemCapability.Customization.EnterpriseDeviceManager

模型约束: 此接口仅可在Stage模型下使用。

参数:

展开
参数名 类型 必填 说明
admin Want | null

企业设备管理扩展组件。Want中必须包含企业设备管理扩展能力的abilityName和所在应用的bundleName。

当设备存在多个MDM应用时,传入Want时查询对应企业设备管理应用设置的策略,传入null时查询实际生效的策略。

bundleName string 被设置剪贴板策略的应用包名。
accountId number 用户ID,指定具体用户,取值范围:大于等于0。accountId可以通过@ohos.account.osAccount中的getOsAccountLocalId等接口来获取。

返回值:

展开
类型 说明
string 返回JSON字符串形式的设备剪贴板策略。

错误码

以下错误码的详细介绍请参见企业设备管理错误码通用错误码

展开
错误码ID 错误信息
9200001 The application is not an administrator application of the device.
9200002 The administrator application does not have permission to manage the device.
201 Permission verification failed. The application does not have the permission required to call the API.

示例:

收起
自动换行
深色代码主题
复制
  1. import { securityManager } from '@kit.MDMKit';
  2. // 需根据实际情况进行替换
  3. let bundleName: string = 'com.example.myapplication';
  4. let accountId: number = 100;
  5. try {
  6. // 参数需根据实际情况进行替换
  7. let result: string = securityManager.getAppClipboardPolicy(null, bundleName, accountId);
  8. console.info(`Succeeded in getting clipboard policy, result : ${result}`);
  9. } catch (err) {
  10. console.error(`Failed to get clipboard policy. Code: ${err.code}, message: ${err.message}`);
  11. }

securityManager.setWatermarkImage14+

Phone14+PC/2in114+Tablet14+

setWatermarkImage(admin: Want, bundleName: string, source: string | image.PixelMap, accountId: number): void

为指定用户的指定应用设置水印策略。当前只支持最多保存100个策略。

说明

1.本接口适用于企业场景下为三方应用设置水印,降低企业信息泄露风险。不建议为系统应用设置水印(如:桌面应用),可能存在未知异常。

2.水印图片会以平铺方式重复覆盖整个应用界面。

需要权限: ohos.permission.ENTERPRISE_MANAGE_SECURITY

系统能力: SystemCapability.Customization.EnterpriseDeviceManager

模型约束: 此接口仅可在Stage模型下使用。

冲突规则: 独占, 同一个用户下的同一个应用的水印独占。不同用户、不同应用的水印合并

参数:

展开
参数名 类型 必填 说明
admin Want 企业设备管理扩展组件。Want中必须包含企业设备管理扩展能力的abilityName和所在应用的bundleName。
bundleName string 被设置水印的应用包名。
source string | image.PixelMap

string表示图像路径,图像路径为应用沙箱路径(应用沙箱路径和真实路径的对应关系可参见:应用沙箱路径和真实物理路径的对应关系)等应用有权限访问的路径。

image.PixelMap表示图像对象。

图像像素占用大小不得超过500KB。

图像像素占用大小计算公式:图像宽度(像素)×图像高度 (像素)×每个像素占用的字节数(通常为4)。例如:一张 100x100 的图片,图像像素占用大小为100×100×4=40000字节。

accountId number 用户ID。accountId可以通过@ohos.account.osAccount中的getOsAccountLocalId等接口来获取。

错误码

以下错误码的详细介绍请参见企业设备管理错误码通用错误码

展开
错误码ID 错误信息
9200001 The application is not an administrator application of the device.
9200002 The administrator application does not have permission to manage the device.
201 Permission verification failed. The application does not have the permission required to call the API.
401 Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed.

示例:

收起
自动换行
深色代码主题
复制
  1. import { securityManager } from '@kit.MDMKit';
  2. import { Want } from '@kit.AbilityKit';
  3. let wantTemp: Want = {
  4. // 需根据实际情况进行替换
  5. bundleName: 'com.example.myapplication',
  6. abilityName: 'EnterpriseAdminAbility'
  7. };
  8. // 需根据实际情况进行替换
  9. let bundleName: string = 'com.example.myapplication';
  10. let source: string = '/data/storage/el1/base/test.png';
  11. let accountId: number = 100;
  12. try {
  13. securityManager.setWatermarkImage(wantTemp, bundleName, source, accountId);
  14. console.info(`Succeeded in setting watermarkImage policy.`);
  15. } catch (err) {
  16. console.error(`Failed to set watermarkImage policy. Code: ${err.code}, message: ${err.message}`);
  17. }

securityManager.cancelWatermarkImage14+

Phone14+PC/2in114+Tablet14+

cancelWatermarkImage(admin: Want, bundleName: string, accountId: number): void

取消指定用户的水印策略。当应用不再需要水印保护或需要更换水印时,企业可调用此接口取消水印策略。当使用企业数字空间时,只能在当前用户下取消当前用户的水印。即可以在100用户下取消100用户的水印,不可以在100用户下取消101用户的水印。

需要权限: ohos.permission.ENTERPRISE_MANAGE_SECURITY

系统能力: SystemCapability.Customization.EnterpriseDeviceManager

模型约束: 此接口仅可在Stage模型下使用。

参数:

展开
参数名 类型 必填 说明
admin Want 企业设备管理扩展组件。Want中必须包含企业设备管理扩展能力的abilityName和所在应用的bundleName。
bundleName string 被取消水印的应用包名。
accountId number 用户ID。accountId可以通过@ohos.account.osAccount中的getOsAccountLocalId等接口来获取。

错误码

以下错误码的详细介绍请参见企业设备管理错误码通用错误码

展开
错误码ID 错误信息
9200001 The application is not an administrator application of the device.
9200002 The administrator application does not have permission to manage the device.
201 Permission verification failed. The application does not have the permission required to call the API.
401 Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed.

示例:

收起
自动换行
深色代码主题
复制
  1. import { securityManager } from '@kit.MDMKit';
  2. import { Want } from '@kit.AbilityKit';
  3. let wantTemp: Want = {
  4. // 需根据实际情况进行替换
  5. bundleName: 'com.example.myapplication',
  6. abilityName: 'EnterpriseAdminAbility'
  7. };
  8. // 需根据实际情况进行替换
  9. let bundleName: string = 'com.example.myapplication';
  10. let accountId: number = 100;
  11. try {
  12. securityManager.cancelWatermarkImage(wantTemp, bundleName, accountId);
  13. console.info(`Succeeded in cancelling watermarkImage policy.`);
  14. } catch (err) {
  15. console.error(`Failed to cancel watermarkImage policy. Code: ${err.code}, message: ${err.message}`);
  16. }

securityManager.setPermissionManagedState20+

Phone20+PC/2in120+Tablet20+

setPermissionManagedState(admin: Want, applicationInstance: ApplicationInstance, permissions: Array<string>, managedState: PermissionManagedState): void

设置指定应用的user_grant权限的管理策略。适用于企业应用批量部署场景,如静默授权减少权限弹窗干扰、统一企业应用权限管理策略,提升员工使用体验和管理效率。

需要权限: ohos.permission.ENTERPRISE_MANAGE_USER_GRANT_PERMISSION

系统能力: SystemCapability.Customization.EnterpriseDeviceManager

模型约束: 此接口仅可在Stage模型下使用。

冲突规则: 同一个应用实例的同一个权限独占,不同应用实例不同权限合并

参数:

展开
参数名 类型 必填 说明
admin Want 企业设备管理扩展组件。Want中必须包含企业设备管理扩展能力的abilityName和所在应用的bundleName。
applicationInstance ApplicationInstance 指定应用实例。
permissions Array<string> 需要管理的权限名称列表,仅支持user_grant权限。权限名称列表以应用权限组为单位。列表中应包含应用在module.json5中声明的同一权限组内的所有权限。例如:应用如果在module.json5中声明需要ohos.permission.READ_CALENDAR和ohos.permission.WRITE_CALENDAR权限,则传入的权限名称列表必须同时包含ohos.permission.READ_CALENDAR和ohos.permission.WRITE_CALENDAR两个权限。
managedState PermissionManagedState 应用权限的管理策略。

错误码

以下错误码的详细介绍请参见企业设备管理错误码通用错误码

展开
错误码ID 错误信息
9200001 The application is not an administrator application of the device.
9200002 The administrator application does not have permission to manage the device.
9200010 A conflict policy has been configured.
9200012 Parameter verification failed.
201 Permission verification failed. The application does not have the permission required to call the API.

示例:

收起
自动换行
深色代码主题
复制
  1. import { Want } from '@kit.AbilityKit';
  2. import { securityManager } from '@kit.MDMKit';
  3. let wantTemp: Want = {
  4. // 需根据实际情况进行替换
  5. bundleName: 'com.example.myapplication',
  6. abilityName: 'EnterpriseAdminAbility'
  7. };
  8. let appInstanceTemp: securityManager.ApplicationInstance = {
  9. // 需根据实际情况进行替换
  10. appIdentifier: '736498586',
  11. appIndex: 0,
  12. accountId: 100
  13. };
  14. let permissionsTemp: Array<string> = ['ohos.permission.CAMERA', 'ohos.permission.LOCATION'];
  15. try {
  16. securityManager.setPermissionManagedState(wantTemp, appInstanceTemp, permissionsTemp,
  17. securityManager.PermissionManagedState.GRANTED);
  18. console.info('Succeeded in setting permission managed state.');
  19. } catch (err) {
  20. console.error(`Failed to set permission managed state. Code: ${err.code}, message: ${err.message}`);
  21. }

securityManager.getPermissionManagedState20+

Phone20+PC/2in120+Tablet20+

getPermissionManagedState(admin: Want, applicationInstance: ApplicationInstance, permission: string): PermissionManagedState

获取指定应用的指定user_grant权限的管理策略。

需要权限: ohos.permission.ENTERPRISE_MANAGE_USER_GRANT_PERMISSION

系统能力: SystemCapability.Customization.EnterpriseDeviceManager

模型约束: 此接口仅可在Stage模型下使用。

参数:

展开
参数名 类型 必填 说明
admin Want 企业设备管理扩展组件。Want中必须包含企业设备管理扩展能力的abilityName和所在应用的bundleName。
applicationInstance ApplicationInstance 指定应用实例。
permission string 需要获取管理策略的权限名称,仅支持user_grant权限。

返回值:

展开
类型 说明
PermissionManagedState 应用权限的管理策略。

错误码

以下错误码的详细介绍请参见企业设备管理错误码通用错误码

展开
错误码ID 错误信息
9200001 The application is not an administrator application of the device.
9200002 The administrator application does not have permission to manage the device.
9200012 Parameter verification failed.
201 Permission verification failed. The application does not have the permission required to call the API.

示例:

收起
自动换行
深色代码主题
复制
  1. import { Want } from '@kit.AbilityKit';
  2. import { securityManager } from '@kit.MDMKit';
  3. let wantTemp: Want = {
  4. // 需根据实际情况进行替换
  5. bundleName: 'com.example.myapplication',
  6. abilityName: 'EnterpriseAdminAbility'
  7. };
  8. let appInstanceTemp: securityManager.ApplicationInstance = {
  9. // 需根据实际情况进行替换
  10. appIdentifier: '736498586',
  11. appIndex: 0,
  12. accountId: 100
  13. };
  14. let permissionTemp: string = 'ohos.permission.ENTERPRISE_MANAGE_USER_GRANT_PERMISSION';
  15. try {
  16. let result: securityManager.PermissionManagedState =
  17. securityManager.getPermissionManagedState(wantTemp, appInstanceTemp, permissionTemp);
  18. console.info(`Succeeded in getting permission managed state, result : ${result}`);
  19. } catch (err) {
  20. console.error(`Failed to get permission managed state. Code: ${err.code}, message: ${err.message}`);
  21. }

securityManager.setExternalSourceExtensionsPolicy22+

PC/2in122+

setExternalSourceExtensionsPolicy(admin: Want, policy: common.ManagedPolicy): void

设置外部来源扩展程序的管控策略。策略设置后,系统将按照设置的策略控制外部来源扩展程序的运行行为。适用于企业安全管控场景,如防止员工安装非授权浏览器扩展程序,或强制开启企业批准的扩展程序功能,保障企业终端安全。

  • DEFAULT:

    默认,表示无管控策略,用户可以通过“设置-隐私与安全-高级”中的“运行外部来源的扩展程序”开关来设置是否允许扩展程序运行。

  • DISALLOW:

    禁用。设置此策略后,禁止运行外部来源的扩展程序,运行中的扩展程序可继续运行,扩展程序关闭后无法启动运行。用户无法开启“设置-隐私和安全-高级”中的“运行外部来源的扩展程序”开关。

  • FORCE_OPEN:

    强制开启。设置此策略后,允许运行外部来源的扩展程序,用户无法关闭“设置-隐私和安全-高级”中的“运行外部来源的扩展程序”开关。

需要权限: ohos.permission.ENTERPRISE_MANAGE_SECURITY

系统能力: SystemCapability.Customization.EnterpriseDeviceManager

设备行为差异: 该接口在PC/2in1设备中可正常调用,在其他设备中返回801错误码。

模型约束: 此接口仅可在Stage模型下使用。

冲突规则: 独占

参数:

展开
参数名 类型 必填 说明
admin Want 企业设备管理扩展组件。Want中必须包含企业设备管理扩展能力的abilityName和所在应用的bundleName。
policy common.ManagedPolicy 管控策略。

错误码:

以下错误码的详细介绍请参见企业设备管理错误码通用错误码

展开
错误码ID 错误信息
9200001 The application is not an administrator application of the device.
9200002 The administrator application does not have permission to manage the device.
9200010 A conflict policy has been configured.
9200012 Parameter verification failed.
201 Permission verification failed. The application does not have the permission required to call the API.
801 Capability not supported. Failed to call the API due to limited device capabilities.

示例:

收起
自动换行
深色代码主题
复制
  1. import { common, securityManager } from '@kit.MDMKit';
  2. import { Want } from '@kit.AbilityKit';
  3. let wantTemp: Want = {
  4. // 需根据实际情况进行替换
  5. bundleName: 'com.example.myapplication',
  6. abilityName: 'EnterpriseAdminAbility'
  7. };
  8. try {
  9. securityManager.setExternalSourceExtensionsPolicy(wantTemp, common.ManagedPolicy.FORCE_OPEN);
  10. console.info(`Succeeded in setting managed policy.`);
  11. } catch (err) {
  12. console.error(`Failed to set managed policy. Code: ${err.code}, message: ${err.message}`);
  13. }

securityManager.getExternalSourceExtensionsPolicy22+

PC/2in122+

getExternalSourceExtensionsPolicy(admin: Want): common.ManagedPolicy

获取外部来源扩展程序的管控策略。

本接口通过传入Want查询对应企业设备管理应用设置的策略,如需查询实际生效的策略,请使用securityManager.getExternalSourceExtensionsPolicy接口。

需要权限: ohos.permission.ENTERPRISE_MANAGE_SECURITY

系统能力: SystemCapability.Customization.EnterpriseDeviceManager

设备行为差异: 该接口在PC/2in1设备中可正常调用,在其他设备中返回801错误码。

模型约束: 此接口仅可在Stage模型下使用。

参数:

展开
参数名 类型 必填 说明
admin Want 企业设备管理扩展组件。Want中必须包含企业设备管理扩展能力的abilityName和所在应用的bundleName。

返回值:

展开
类型 说明
common.ManagedPolicy 返回ManagedPolicy枚举类型的管控策略。

错误码:

以下错误码的详细介绍请参见企业设备管理错误码通用错误码

展开
错误码ID 错误信息
9200001 The application is not an administrator application of the device.
9200002 The administrator application does not have permission to manage the device.
201 Permission verification failed. The application does not have the permission required to call the API.
801 Capability not supported. Failed to call the API due to limited device capabilities.

示例:

收起
自动换行
深色代码主题
复制
  1. import { common, securityManager } from '@kit.MDMKit';
  2. import { Want } from '@kit.AbilityKit';
  3. let wantTemp: Want = {
  4. // 需根据实际情况进行替换
  5. bundleName: 'com.example.myapplication',
  6. abilityName: 'EnterpriseAdminAbility'
  7. };
  8. try {
  9. let result: common.ManagedPolicy = securityManager.getExternalSourceExtensionsPolicy(wantTemp);
  10. console.info(`Succeeded in getting managed policy, result : ${result}`);
  11. } catch (err) {
  12. console.error(`Failed to get managed policy. Code: ${err.code}, message: ${err.message}`);
  13. }

securityManager.getExternalSourceExtensionsPolicy

PC/2in126.0.0+

getExternalSourceExtensionsPolicy(admin: Want | null): common.ManagedPolicy

获取外部来源扩展程序的管控策略。

起始版本: 26.0.0

需要权限: ohos.permission.ENTERPRISE_MANAGE_SECURITY

系统能力: SystemCapability.Customization.EnterpriseDeviceManager

设备行为差异: 该接口在PC/2in1设备中可正常调用,在其他设备中返回801错误码。

模型约束: 此接口仅可在Stage模型下使用。

参数:

展开
参数名 类型 必填 说明
admin Want | null

企业设备管理扩展组件。Want中必须包含企业设备管理扩展能力的abilityName和所在应用的bundleName。

当设备存在多个MDM应用时,传入Want时查询对应企业设备管理应用设置的策略,传入null时查询实际生效的策略。

返回值:

展开
类型 说明
common.ManagedPolicy 返回ManagedPolicy枚举类型的管控策略。

错误码:

以下错误码的详细介绍请参见企业设备管理错误码通用错误码

展开
错误码ID 错误信息
9200001 The application is not an administrator application of the device.
9200002 The administrator application does not have permission to manage the device.
201 Permission verification failed. The application does not have the permission required to call the API.
801 Capability not supported. Failed to call the API due to limited device capabilities.

示例:

收起
自动换行
深色代码主题
复制
  1. import { common, securityManager } from '@kit.MDMKit';
  2. try {
  3. // 参数需根据实际情况进行替换
  4. let result: common.ManagedPolicy = securityManager.getExternalSourceExtensionsPolicy(null);
  5. console.info(`Succeeded in getting managed policy, result : ${result}`);
  6. } catch (err) {
  7. console.error(`Failed to get managed policy. Code: ${err.code}, message: ${err.message}`);
  8. }

securityManager.installEnterpriseReSignatureCertificate24+

Phone24+PC/2in124+Tablet24+

installEnterpriseReSignatureCertificate(admin: Want, certificateAlias: string, fd: number, accountId: number): void

安装企业应用重签名证书。安装成功后,企业可使用该证书对应用进行重签名。

同一用户下最多可下发10本不同证书。证书别名作为证书的唯一标识,不支持重复下发相同别名的证书。如需更新同一别名的证书,需先调用uninstallEnterpriseReSignatureCertificate进行卸载。

在MDM应用卸载或admin取消激活场景下,已安装的证书会保留在设备上,不会被移除。

在企业应用分发场景下,由开发者到华为AGC申请企业应用重签名证书,开发者可以使用重签名证书对企业应用进行二次签名,签名完成后将应用包提供给企业管理员。企业管理员可以将重签名后的应用安装在已部署重签名证书的企业设备上。

企业应用重签名证书使用流程:

首先,由开发者到华为AGC申请企业应用重签名证书,然后依照以下步骤。

1.通过MDM应用安装企业应用重签名证书;

2.开发者利用签名工具(如ohos-signer或DevEco Studio签名插件),对原始HAP包进行二次签名;

3.安装重签名应用(可以通过企业私有应用市场安装);

4.运行应用。

规格约束:

1.安装新的签名证书之后,使用旧签名证书的应用可以继续运行;

2.已经安装的企业应用,安装了新的企业签名证书后,已安装的应用如需更新,可以直接覆盖安装,无需先卸载原应用;

3.企业场景下,特别是在涉及信息安全的场景中,企业需要确保员工使用的移动设备中仅安装并运行特定的内部软件和工具。企业应用重签名证书通过统一的应用身份标识,与系统的应用管理与权限控制机制配合使用,可支持企业应用的静默安装、受控的系统能力调用及运行范围限制,从而实现企业软件在受控终端上的准入控制与安全管理。

需要权限: ohos.permission.ENTERPRISE_MANAGE_SECURITY

系统能力: SystemCapability.Customization.EnterpriseDeviceManager

模型约束: 此接口仅可在Stage模型下使用。

冲突规则: 配置

参数:

展开
参数名 类型 必填 说明
admin Want 企业设备管理扩展组件。Want中必须包含企业设备管理扩展能力的abilityName和所在应用的bundleName。
certificateAlias string 证书别名,必须以'.cer'结尾。
fd number 表示已存在的重签名证书文件描述符,证书文件需要放置于应用沙箱目录
accountId number 用户ID,指定具体用户,取值范围:大于等于0。accountId可以通过@ohos.account.osAccount中的getOsAccountLocalId等接口来获取。

错误码

以下错误码的详细介绍请参见企业设备管理错误码通用错误码

展开
错误码ID 错误信息
9200001 The application is not an administrator application of the device.
9200002 The administrator application does not have permission to manage the device.
9200012 Parameter verification failed.
9201006 The number of certificates has reached the limit.
9201007 The certificate is invalid.
201 Permission verification failed. The application does not have the permission required to call the API.

示例:

收起
自动换行
深色代码主题
复制
  1. import { securityManager } from '@kit.MDMKit';
  2. import { Want } from '@kit.AbilityKit';
  3. import { fileIo } from '@kit.CoreFileKit';
  4. let wantTemp: Want = {
  5. // 需根据实际情况进行替换
  6. bundleName: 'com.example.myapplication',
  7. abilityName: 'EnterpriseAdminAbility'
  8. };
  9. // test.cer证书文件需要放置在应用沙箱目录下,并确保是有效的企业应用重签名证书
  10. // 需根据实际情况进行替换
  11. const filePath = '/test.cer';
  12. // 需根据实际情况进行替换
  13. let certificateAlias: string = 'test.cer';
  14. let fd: number = fileIo.openSync(filePath, fileIo.OpenMode.READ_ONLY).fd;
  15. // 需根据实际情况进行替换
  16. let accountId: number = 100;
  17. try {
  18. securityManager.installEnterpriseReSignatureCertificate(
  19. wantTemp, certificateAlias, fd, accountId);
  20. console.info('Success in installing enterprise re signature certificate.');
  21. } catch (err) {
  22. console.error(`Failed to install enterprise re signature certificate.
  23. Code: ${err.code}, message: ${err.message}`);
  24. };

securityManager.uninstallEnterpriseReSignatureCertificate24+

Phone24+PC/2in124+Tablet24+

uninstallEnterpriseReSignatureCertificate(admin: Want, certificateAlias: string, accountId: number): void

卸载企业应用重签名证书。卸载企业重签名证书后,使用该证书签名的应用在设备重启前正常运行,设备重启后无法运行。

使用场景:

1.安装新证书:调用installEnterpriseReSignatureCertificate接口安装新证书后,经新证书重签名的应用可正常运行。如果旧签名证书对应的应用为超级设备管理应用,需先取消激活后才能卸载证书,否则卸载证书后该应用无法卸载且无法运行。

2.恢复误删证书:调用installEnterpriseReSignatureCertificate接口重新安装误删除的证书后,已重签名的应用可正常运行,不受影响。

注意

删除证书常见证书过期和证书泄露场景,建议开发者在实现该功能时,强提示管理员谨慎删除证书,并确保删除证书前加载新的重签名证书,并完成所有应用更新切换到新的重签名证书,否则重启后历史安装的应用将无法运行。

需要权限: ohos.permission.ENTERPRISE_MANAGE_SECURITY

系统能力: SystemCapability.Customization.EnterpriseDeviceManager

模型约束: 此接口仅可在Stage模型下使用。

参数:

展开
参数名 类型 必填 说明
admin Want 企业设备管理扩展组件。Want中必须包含企业设备管理扩展能力的abilityName和所在应用的bundleName。
certificateAlias string 证书别名,必须以'.cer'结尾。
accountId number 用户ID,指定具体用户,取值范围:大于等于0。accountId可以通过@ohos.account.osAccount中的getOsAccountLocalId等接口来获取。

错误码

以下错误码的详细介绍请参见企业设备管理错误码通用错误码

展开
错误码ID 错误信息
9200001 The application is not an administrator application of the device.
9200002 The administrator application does not have permission to manage the device.
9200012 Parameter verification failed.
9201008 The certificate does not exist.
201 Permission verification failed. The application does not have the permission required to call the API.

示例:

收起
自动换行
深色代码主题
复制
  1. import { securityManager } from '@kit.MDMKit';
  2. import { Want } from '@kit.AbilityKit';
  3. let wantTemp: Want = {
  4. // 需根据实际情况进行替换
  5. bundleName: 'com.example.myapplication',
  6. abilityName: 'EnterpriseAdminAbility'
  7. };
  8. // 需根据实际情况进行替换
  9. let certificateAlias: string = 'test.cer';
  10. // 需根据实际情况进行替换
  11. let accountId: number = 100;
  12. try {
  13. securityManager.uninstallEnterpriseReSignatureCertificate(
  14. wantTemp, certificateAlias, accountId);
  15. console.info('Success in uninstalling enterprise re signature certificate.');
  16. } catch (err) {
  17. console.error(`Failed to uninstall enterprise re signature certificate.
  18. Code: ${err.code}, message: ${err.message}`);
  19. };

securityManager.setScreenWatermarkImage

Phone26.0.0+PC/2in126.0.0+Tablet26.0.0+

setScreenWatermarkImage(admin: Want, pixelMap: image.PixelMap): void

设置屏幕水印策略,对所有用户生效。

说明

1.屏幕水印策略会将设置的图片平铺覆盖整个屏幕,建议使用带透明度的图片以确保设备屏幕内容可见。

2.当水印图片尺寸小于屏幕时,图片会被拉伸;当水印图片尺寸大于屏幕时,图片会被压缩。该实现方式与应用级别水印的重复平铺方式不同。

起始版本: 26.0.0

需要权限: ohos.permission.ENTERPRISE_MANAGE_SECURITY

系统能力: SystemCapability.Customization.EnterpriseDeviceManager

模型约束: 此接口仅可在Stage模型下使用。

冲突规则: 配置

参数:

展开
参数名 类型 必填 说明
admin Want 企业设备管理扩展组件。Want中必须包含企业设备管理扩展能力的abilityName和所在应用的bundleName。
pixelMap image.PixelMap 图像对象。图片宽度不超过设备屏幕宽度的两倍,图片高度不超过设备屏幕高度的两倍。图片像素占用大小不得超过128MB。图片像素占用大小计算公式:图片宽度(像素)×图片高度(像素)×每个像素占用的字节数(通常为4)。例如:一张100×100的图片,像素占用大小为100×100×4=40000字节。对于1920×1080分辨率的屏幕,若使用相同分辨率的图片,像素占用大小为1920×1080×4=8294400字节(约7.9MB)。

错误码

以下错误码的详细介绍请参见企业设备管理错误码通用错误码

展开
错误码ID 错误信息
9200001 The application is not an administrator application of the device.
9200002 The administrator application does not have permission to manage the device.
9200012 Parameter verification failed.
201 Permission verification failed. The application does not have the permission required to call the API.

示例:

收起
自动换行
深色代码主题
复制
  1. import { securityManager } from '@kit.MDMKit';
  2. import { common, Want } from '@kit.AbilityKit';
  3. import { image } from '@kit.ImageKit';
  4. let wantTemp: Want = {
  5. // 需根据实际情况进行替换
  6. bundleName: 'com.example.myapplication',
  7. abilityName: 'EnterpriseAdminAbility'
  8. };
  9. // 请在组件内获取context,确保this.getUIContext().getHostContext()返回结果为UIAbilityContext
  10. const context = this.getUIContext().getHostContext() as common.UIAbilityContext;
  11. // 此处'test.png'仅作示例,请开发者自行替换
  12. const path: string = context.filesDir + "/test.png";
  13. // 创建ImageSource
  14. const imageSource: image.ImageSource = image.createImageSource(path);
  15. // 创建PixelMap
  16. imageSource.createPixelMap().then((pixelMap: image.PixelMap) => {
  17. try {
  18. securityManager.setScreenWatermarkImage(wantTemp, pixelMap);
  19. console.info(`Succeeded in setting screen watermark image.`);
  20. } catch (err) {
  21. console.error(`Failed to set screen watermark image. Code: ${err.code}, message: ${err.message}`);
  22. }
  23. }).catch((err: Error) => {
  24. console.error(`Failed to create PixelMap. message: ${err.message}`);
  25. });

securityManager.cancelScreenWatermarkImage

Phone26.0.0+PC/2in126.0.0+Tablet26.0.0+

cancelScreenWatermarkImage(admin: Want): void

取消屏幕水印策略,对所有用户生效。取消成功后,设备屏幕上的水印消失。当设备不再需要屏幕水印保护时,企业可调用此接口取消水印策略。只有设置屏幕水印的用户才能取消该水印,例如用户100设置的屏幕水印,用户101无法取消。

起始版本: 26.0.0

需要权限: ohos.permission.ENTERPRISE_MANAGE_SECURITY

系统能力: SystemCapability.Customization.EnterpriseDeviceManager

模型约束: 此接口仅可在Stage模型下使用。

参数:

展开
参数名 类型 必填 说明
admin Want 企业设备管理扩展组件。Want中必须包含企业设备管理扩展能力的abilityName和所在应用的bundleName。

错误码

以下错误码的详细介绍请参见企业设备管理错误码通用错误码

展开
错误码ID 错误信息
9200001 The application is not an administrator application of the device.
9200002 The administrator application does not have permission to manage the device.
201 Permission verification failed. The application does not have the permission required to call the API.

示例:

收起
自动换行
深色代码主题
复制
  1. import { securityManager } from '@kit.MDMKit';
  2. import { Want } from '@kit.AbilityKit';
  3. let wantTemp: Want = {
  4. // 需根据实际情况进行替换
  5. bundleName: 'com.example.myapplication',
  6. abilityName: 'EnterpriseAdminAbility'
  7. };
  8. try {
  9. securityManager.cancelScreenWatermarkImage(wantTemp);
  10. console.info(`Succeeded in canceling screen watermark image.`);
  11. } catch (err) {
  12. console.error(`Failed to cancel screen watermark image. Code: ${err.code}, message: ${err.message}`);
  13. }

securityManager.setDisallowedPermission

Phone26.0.0+PC/2in126.0.0+Tablet26.0.0+

setDisallowedPermission(admin: Want, permission: string, disallow: boolean, accountId: number): void

禁用指定用户下的指定权限,禁用后指定用户下的所有应用申请和使用指定权限时默认拒绝。适用于企业安全合规场景,如禁用相机、麦克风等高风险权限防止隐私泄露,或禁用特定功能(如蓝牙分享)防止企业数据外传。

说明

1.只能禁用权限APL等级为normal或system_basic的权限,否则返回错误码9201045。

2.单个用户下最多可以禁用200个权限。

3.权限禁用后,仅影响应用(系统应用和普通应用)使用对应的权限,不影响系统SA使用对应的权限。

起始版本: 26.0.0

需要权限: ohos.permission.ENTERPRISE_MANAGE_SECURITY

系统能力: SystemCapability.Customization.EnterpriseDeviceManager

模型约束: 此接口仅可在Stage模型下使用。

冲突规则: 针对同一个权限设置从严管控,不同权限设置合并

参数:

展开
参数名 类型 必填 说明
admin Want 企业设备管理扩展组件。Want中必须包含企业设备管理扩展能力的abilityName和所在应用的bundleName。
permission string 权限名称。
disallow boolean 是否禁用。true表示禁用,false表示取消禁用。
accountId number 用户ID,指定具体用户,取值范围:大于等于0。accountId可以通过@ohos.account.osAccount中的getOsAccountLocalId等接口来获取。

错误码:

以下错误码的详细介绍请参见企业设备管理错误码通用错误码

展开
错误码ID 错误信息
9200001 The application is not an administrator application of the device.
9200002 The administrator application does not have permission to manage the device.
9200012 Parameter verification failed.
9201045 This permission cannot be disallowed.
201 Permission verification failed. The application does not have the permission required to call the API.

示例:

收起
自动换行
深色代码主题
复制
  1. import { securityManager } from '@kit.MDMKit';
  2. import { Want } from '@kit.AbilityKit';
  3. let wantTemp: Want = {
  4. // 需根据实际情况进行替换
  5. bundleName: 'com.example.myapplication',
  6. abilityName: 'EnterpriseAdminAbility'
  7. };
  8. // 需根据实际情况进行替换
  9. let permission: string = 'ohos.permission.CAMERA';
  10. let disallow: boolean = true;
  11. let accountId: number = 100;
  12. try {
  13. securityManager.setDisallowedPermission(wantTemp, permission, disallow, accountId);
  14. console.info(`Succeeded in setting disallowed permission.`);
  15. } catch (err) {
  16. console.error(`Failed to set disallowed permission. Code: ${err.code}, message: ${err.message}`);
  17. }

securityManager.getDisallowedPermissions

Phone26.0.0+PC/2in126.0.0+Tablet26.0.0+

getDisallowedPermissions(admin: Want | null, accountId: number): Array<string>

获取指定用户下禁用的权限列表。

起始版本: 26.0.0

需要权限: ohos.permission.ENTERPRISE_MANAGE_SECURITY

系统能力: SystemCapability.Customization.EnterpriseDeviceManager

模型约束: 此接口仅可在Stage模型下使用。

参数:

展开
参数名 类型 必填 说明
admin Want | null 企业设备管理扩展组件。Want中必须包含企业设备管理扩展能力的abilityName和所在应用的bundleName。当admin为null时,表示获取所有企业设备管理应用下发的禁用权限列表,返回合并后的结果。
accountId number 用户ID,指定具体用户,取值范围:大于等于0。accountId可以通过@ohos.account.osAccount中的getOsAccountLocalId等接口来获取。

返回值:

展开
类型 说明
Array<string> 返回禁用的权限列表。

错误码:

以下错误码的详细介绍请参见企业设备管理错误码通用错误码

展开
错误码ID 错误信息
9200001 The application is not an administrator application of the device.
9200002 The administrator application does not have permission to manage the device.
9200012 Parameter verification failed.
201 Permission verification failed. The application does not have the permission required to call the API.

示例:

收起
自动换行
深色代码主题
复制
  1. import { securityManager } from '@kit.MDMKit';
  2. import { Want } from '@kit.AbilityKit';
  3. let wantTemp: Want = {
  4. // 需根据实际情况进行替换
  5. bundleName: 'com.example.myapplication',
  6. abilityName: 'EnterpriseAdminAbility'
  7. };
  8. // 需根据实际情况进行替换
  9. let accountId: number = 100;
  10. try {
  11. let result: Array<string> = securityManager.getDisallowedPermissions(wantTemp, accountId);
  12. console.info(`Succeeded in getting disallowed permissions, result : ${JSON.stringify(result)}`);
  13. } catch (err) {
  14. console.error(`Failed to get disallowed permissions. Code: ${err.code}, message: ${err.message}`);
  15. }

securityManager.addAllowedPermissionBundle

Phone26.0.0+PC/2in126.0.0+Tablet26.0.0+

addAllowedPermissionBundle(admin: Want, permission: string, applicationInstance: common.ApplicationInstance): void

将应用添加至权限使用例外名单,例外名单中的应用不受setDisallowedPermission设置的权限禁用策略限制。适用于企业应用场景,如相机权限被禁用时,允许考勤应用、协作办公应用继续使用相机功能,保障企业关键业务正常运行。

说明

1.必须先通过setDisallowedPermission接口禁用权限后,才能添加应用到权限使用例外名单,否则返回错误码9201044。

2.应用实际未申请指定权限时,不可将应用添加到权限使用例外名单中。例如相机权限被禁用时,A应用实际未申请相机权限,则不能添加A应用到相机权限使用例外名单中,返回错误码9200012。可以通过bm dump命令查询应用是否申请指定权限。

3.当指定权限通过setDisallowedPermission接口取消禁用后,该权限对应的权限使用例外名单会同步清理。

4.所有用户下单个权限最多可以设置1024个应用到权限使用例外名单。

5.系统应用和普通应用都可以添加。

起始版本: 26.0.0

需要权限: ohos.permission.ENTERPRISE_MANAGE_SECURITY

系统能力: SystemCapability.Customization.EnterpriseDeviceManager

模型约束: 此接口仅可在Stage模型下使用。

冲突规则: 合并

参数:

展开
参数名 类型 必填 说明
admin Want 企业设备管理扩展组件。Want中必须包含企业设备管理扩展能力的abilityName和所在应用的bundleName。
permission string 权限名称。
applicationInstance common.ApplicationInstance 需添加到权限使用例外名单的应用实例信息。

错误码:

以下错误码的详细介绍请参见企业设备管理错误码通用错误码

展开
错误码ID 错误信息
9200001 The application is not an administrator application of the device.
9200002 The administrator application does not have permission to manage the device.
9200012 Parameter verification failed.
9201015 The application is not installed.
9201044 This permission is not disallowed. Applications cannot be added to or removed from the trustlist.
201 Permission verification failed. The application does not have the permission required to call the API.

示例:

收起
自动换行
深色代码主题
复制
  1. import { securityManager, common } from '@kit.MDMKit';
  2. import { Want } from '@kit.AbilityKit';
  3. let wantTemp: Want = {
  4. // 需根据实际情况进行替换
  5. bundleName: 'com.example.myapplication',
  6. abilityName: 'EnterpriseAdminAbility'
  7. };
  8. // 需根据实际情况进行替换
  9. let permission: string = 'ohos.permission.CAMERA';
  10. let disallow: boolean = true;
  11. let accountId: number = 100;
  12. // 该应用已经申请了ohos.permission.CAMERA权限
  13. let appInstance: common.ApplicationInstance = {
  14. appIdentifier: '123456789',
  15. appIndex: 0,
  16. accountId: 100
  17. };
  18. try {
  19. // 禁用ohos.permission.CAMERA权限
  20. securityManager.setDisallowedPermission(wantTemp, permission, disallow, accountId);
  21. // 设置指定应用可以继续使用ohos.permission.CAMERA权限
  22. securityManager.addAllowedPermissionBundle(wantTemp, permission, appInstance);
  23. console.info(`Succeeded in adding allowed permission bundle.`);
  24. } catch (err) {
  25. console.error(`Failed to add allowed permission bundle. Code: ${err.code}, message: ${err.message}`);
  26. }

securityManager.removeAllowedPermissionBundle

Phone26.0.0+PC/2in126.0.0+Tablet26.0.0+

removeAllowedPermissionBundle(admin: Want, permission: string, applicationInstance: common.ApplicationInstance): void

从权限使用例外名单中移除指定应用,移除后该应用不能继续使用对应的权限。

说明

必须先通过setDisallowedPermission接口禁用权限后,才能从权限使用例外名单移除应用,否则返回错误码9201044。

起始版本: 26.0.0

需要权限: ohos.permission.ENTERPRISE_MANAGE_SECURITY

系统能力: SystemCapability.Customization.EnterpriseDeviceManager

模型约束: 此接口仅可在Stage模型下使用。

冲突规则: 合并

参数:

展开
参数名 类型 必填 说明
admin Want 企业设备管理扩展组件。Want中必须包含企业设备管理扩展能力的abilityName和所在应用的bundleName。
permission string 权限名称。
applicationInstance common.ApplicationInstance 需从权限使用例外名单移除的应用实例信息。

错误码:

以下错误码的详细介绍请参见企业设备管理错误码通用错误码

展开
错误码ID 错误信息
9200001 The application is not an administrator application of the device.
9200002 The administrator application does not have permission to manage the device.
9200012 Parameter verification failed.
9201044 This permission is not disallowed. Applications cannot be added to or removed from the trustlist.
201 Permission verification failed. The application does not have the permission required to call the API.

示例:

收起
自动换行
深色代码主题
复制
  1. import { securityManager, common } from '@kit.MDMKit';
  2. import { Want } from '@kit.AbilityKit';
  3. let wantTemp: Want = {
  4. // 需根据实际情况进行替换
  5. bundleName: 'com.example.myapplication',
  6. abilityName: 'EnterpriseAdminAbility'
  7. };
  8. // 需根据实际情况进行替换
  9. let permission: string = 'ohos.permission.CAMERA';
  10. let appInstance: common.ApplicationInstance = {
  11. appIdentifier: '736498586',
  12. appIndex: 0,
  13. accountId: 100
  14. };
  15. try {
  16. securityManager.removeAllowedPermissionBundle(wantTemp, permission, appInstance);
  17. console.info(`Succeeded in removing allowed permission bundle.`);
  18. } catch (err) {
  19. console.error(`Failed to remove allowed permission bundle. Code: ${err.code}, message: ${err.message}`);
  20. }

securityManager.getAllowedPermissionBundles

Phone26.0.0+PC/2in126.0.0+Tablet26.0.0+

getAllowedPermissionBundles(admin: Want | null, permission: string, accountId: number): Array<common.ApplicationInstance>

获取权限使用例外名单的应用列表。

起始版本: 26.0.0

需要权限: ohos.permission.ENTERPRISE_MANAGE_SECURITY

系统能力: SystemCapability.Customization.EnterpriseDeviceManager

模型约束: 此接口仅可在Stage模型下使用。

参数:

展开
参数名 类型 必填 说明
admin Want | null 企业设备管理扩展组件。Want中必须包含企业设备管理扩展能力的abilityName和所在应用的bundleName。当admin为null时,表示获取所有企业设备管理应用下发的权限使用例外应用名单,返回合并后的结果。
permission string 权限名称。
accountId number 用户ID,指定具体用户,取值范围:大于等于0。accountId可以通过@ohos.account.osAccount中的getOsAccountLocalId等接口来获取。

返回值:

展开
类型 说明
Array<common.ApplicationInstance> 返回权限使用例外名单列表。

错误码:

以下错误码的详细介绍请参见企业设备管理错误码通用错误码

展开
错误码ID 错误信息
9200001 The application is not an administrator application of the device.
9200002 The administrator application does not have permission to manage the device.
9200012 Parameter verification failed.
201 Permission verification failed. The application does not have the permission required to call the API.

示例:

收起
自动换行
深色代码主题
复制
  1. import { securityManager, common } from '@kit.MDMKit';
  2. import { Want } from '@kit.AbilityKit';
  3. let wantTemp: Want = {
  4. // 需根据实际情况进行替换
  5. bundleName: 'com.example.myapplication',
  6. abilityName: 'EnterpriseAdminAbility'
  7. };
  8. // 需根据实际情况进行替换
  9. let permission: string = 'ohos.permission.CAMERA';
  10. let accountId: number = 100;
  11. try {
  12. let result: Array<common.ApplicationInstance> =
  13. securityManager.getAllowedPermissionBundles(wantTemp, permission, accountId);
  14. console.info(`Succeeded in getting allowed permission bundles, result : ${JSON.stringify(result)}`);
  15. } catch (err) {
  16. console.error(`Failed to get allowed permission bundles. Code: ${err.code}, message: ${err.message}`);
  17. }

securityManager.setWatermarkImage

Phone26.0.0+PC/2in126.0.0+Tablet26.0.0+

setWatermarkImage(admin: Want, bundleName: string, source: string | image.PixelMap, accountId: number, properties:WatermarkProperties): void

为指定用户的指定应用设置水印策略。当前只支持最多保存100个策略。

说明

本接口适用于企业场景下为三方应用设置水印,降低企业信息泄露风险。不建议为系统应用设置水印(如:桌面应用),可能存在未知异常。

当水印属性properties行列参数的取值范围是[1, 255]内的整数。若传入小于1或大于255的值,接口会返回错误码9200012。

当水印属性行数和列数都为1时,居中显示单个水印图片。当水印属性行数为m,列数为n时,按m行n列的网格布局排列显示m*n个水印图片。当水印属性行列参数过大,导致网格布局无法适应窗口大小时,水印会以窗口左上角为原点,以平铺方式重复覆盖整个应用窗口界面,水印图片超出界面右侧、下侧的部分会被裁剪(例如屏幕宽高是1260*2720,水印图片宽高是100*100,若设置的行数超过27,或设置的列数超过12,水印会以平铺方式重复覆盖整个应用窗口界面)。

起始版本: 26.0.0

需要权限: ohos.permission.ENTERPRISE_MANAGE_SECURITY

系统能力: SystemCapability.Customization.EnterpriseDeviceManager

模型约束: 此接口仅可在Stage模型下使用。

冲突规则: 独占,同一个用户下的同一个应用的水印独占。不同用户、不同应用的水印合并

参数:

展开
参数名 类型 必填 说明
admin Want 企业设备管理扩展组件。Want中必须包含企业设备管理扩展能力的abilityName和所在应用的bundleName。
bundleName string 被设置水印的应用包名。
source string | image.PixelMap

string表示图像路径,图像路径为应用沙箱路径(应用沙箱路径和真实路径的对应关系可参见:应用沙箱路径和真实物理路径的对应关系)等应用有权限访问的路径。

image.PixelMap表示图像对象。

图像像素占用大小不得超过500KB。

图像像素占用大小计算公式:图像宽度(像素)×图像高度 (像素)×每个像素占用的字节数(通常为4)。例如:一张 100x100 的图片,图像像素占用大小为100×100×4=40000字节。

accountId number 用户ID,指定具体用户,取值范围:大于等于0。accountId可以通过@ohos.account.osAccount中的getOsAccountLocalId等接口来获取。
properties WatermarkProperties 配置水印的行列数。

错误码

以下错误码的详细介绍请参见企业设备管理错误码通用错误码

展开
错误码ID 错误信息
9200001 The application is not an administrator application of the device.
9200002 The administrator application does not have permission to manage the device.
9200012 Parameter verification failed.
201 Permission verification failed. The application does not have the permission required to call the API.

示例:

收起
自动换行
深色代码主题
复制
  1. import { securityManager } from '@kit.MDMKit';
  2. import { Want } from '@kit.AbilityKit';
  3. let wantTemp: Want = {
  4. // 需根据实际情况进行替换
  5. bundleName: 'com.example.myapplication',
  6. abilityName: 'EnterpriseAdminAbility'
  7. };
  8. // 需根据实际情况进行替换
  9. let bundleName: string = 'com.example.myapplication';
  10. let source: string = '/data/storage/el1/base/test.png';
  11. let accountId: number = 100;
  12. // 需根据实际情况进行替换。示例代码水印属性行数和列数都设为1,会居中显示单个水印图片
  13. let properties: securityManager.WatermarkProperties = {
  14. intervalsRow: 1,
  15. intervalsCol: 1
  16. };
  17. try {
  18. securityManager.setWatermarkImage(wantTemp, bundleName, source, accountId, properties);
  19. console.info(`Succeeded in setting watermarkImage policy.`);
  20. } catch (err) {
  21. console.error(`Failed to set watermarkImage policy. Code: ${err.code}, message: ${err.message}`);
  22. }
收起
自动换行
深色代码主题
复制
  1. import { securityManager } from '@kit.MDMKit';
  2. import { Want } from '@kit.AbilityKit';
  3. let wantTemp: Want = {
  4. // 需根据实际情况进行替换
  5. bundleName: 'com.example.myapplication',
  6. abilityName: 'EnterpriseAdminAbility'
  7. };
  8. // 需根据实际情况进行替换
  9. let bundleName: string = 'com.example.myapplication';
  10. let source: string = '/data/storage/el1/base/test.png';
  11. let accountId: number = 100;
  12. // 需根据实际情况进行替换。设备屏幕宽高是1260*2720,水印图片宽高是100*100,示例代码水印属性行数为27,列数为12,按27行12列的网格布局排列显示27*12个水印图片
  13. let properties: securityManager.WatermarkProperties = {
  14. intervalsRow: 27,
  15. intervalsCol: 12
  16. };
  17. try {
  18. securityManager.setWatermarkImage(wantTemp, bundleName, source, accountId, properties);
  19. console.info(`Succeeded in setting watermarkImage policy.`);
  20. } catch (err) {
  21. console.error(`Failed to set watermarkImage policy. Code: ${err.code}, message: ${err.message}`);
  22. }
收起
自动换行
深色代码主题
复制
  1. import { securityManager } from '@kit.MDMKit';
  2. import { Want } from '@kit.AbilityKit';
  3. let wantTemp: Want = {
  4. // 需根据实际情况进行替换
  5. bundleName: 'com.example.myapplication',
  6. abilityName: 'EnterpriseAdminAbility'
  7. };
  8. // 需根据实际情况进行替换
  9. let bundleName: string = 'com.example.myapplication';
  10. let source: string = '/data/storage/el1/base/test.png';
  11. let accountId: number = 100;
  12. // 需根据实际情况进行替换。设备屏幕宽高是1260*2720,水印图片宽高是100*100,示例代码水印属性行数为28,列数为12,28 * 100 > 2720,网格布局无法适应窗口大小,水印会以窗口左上角为原点,以平铺方式重复覆盖整个应用窗口界面,超出界面右侧、下侧的水印图片会被裁剪
  13. let properties: securityManager.WatermarkProperties = {
  14. intervalsRow: 28,
  15. intervalsCol: 12
  16. };
  17. try {
  18. securityManager.setWatermarkImage(wantTemp, bundleName, source, accountId, properties);
  19. console.info(`Succeeded in setting watermarkImage policy.`);
  20. } catch (err) {
  21. console.error(`Failed to set watermarkImage policy. Code: ${err.code}, message: ${err.message}`);
  22. }

securityManager.getWatermarkImageApps

Phone26.0.0+PC/2in126.0.0+Tablet26.0.0+

getWatermarkImageApps(admin: Want, accountId: number): Array<string>

获取指定用户下已设置水印的应用程序包名列表。

起始版本: 26.0.0

需要权限: ohos.permission.ENTERPRISE_MANAGE_SECURITY

系统能力: SystemCapability.Customization.EnterpriseDeviceManager

模型约束: 此接口仅可在Stage模型下使用。

参数:

展开
参数名 类型 必填 说明
admin Want 企业设备管理扩展组件。Want中必须包含企业设备管理扩展能力的abilityName和所在应用的bundleName。
accountId number 用户ID,指定具体用户,取值范围:大于等于0。accountId可以通过@ohos.account.osAccount中的getOsAccountLocalId等接口来获取。

返回值:

展开
类型 说明
Array<string> 返回已设置水印的应用程序包名列表。

错误码:

以下错误码的详细介绍请参见企业设备管理错误码通用错误码

展开
错误码ID 错误信息
9200001 The application is not an administrator application of the device.
9200002 The administrator application does not have permission to manage the device.
9200012 Parameter verification failed.
201 Permission verification failed. The application does not have the permission required to call the API.

示例:

收起
自动换行
深色代码主题
复制
  1. import { securityManager } from '@kit.MDMKit';
  2. import { Want } from '@kit.AbilityKit';
  3. let wantTemp: Want = {
  4. // 需根据实际情况进行替换
  5. bundleName: 'com.example.myapplication',
  6. abilityName: 'EnterpriseAdminAbility'
  7. };
  8. // 需根据实际情况进行替换
  9. let accountId: number = 100;
  10. try {
  11. let result: Array<string> = securityManager.getWatermarkImageApps(wantTemp, accountId);
  12. console.info(`Succeeded in getting watermark image apps, result : ${JSON.stringify(result)}`);
  13. } catch (err) {
  14. console.error(`Failed to get watermark image apps. Code: ${err.code}, message: ${err.message}`);
  15. }

CertBlob

Phone12+PC/2in113+Tablet12+

证书信息。

系统能力: SystemCapability.Customization.EnterpriseDeviceManager

模型约束: 此接口仅可在Stage模型下使用。

展开
名称 类型 只读 可选 说明
inData Uint8Array 证书的二进制内容。
alias string 证书别名,别名长度小于40个字符。

PasswordPolicy

Phone12+PC/2in113+Tablet12+

设备锁屏口令策略。

系统能力: SystemCapability.Customization.EnterpriseDeviceManager

模型约束: 此接口仅可在Stage模型下使用。

展开
名称 类型 只读 可选 说明
complexityRegex string 口令复杂度正则表达式。
validityPeriod number 密码有效期(单位:毫秒)。
additionalDescription string 口令复杂度描述文本,例如:密码中必须包含字母、数字、特殊字符,至少8个字符,最多30个字符。
passwordAlgs PasswordAlgs

处理口令数据使用的加密算法。设置后,PC/2in1设备上将原始口令处理成口令凭据会使用该参数指定的加密算法,其他设备无效果。

起始版本: 26.0.0

模型约束: 此接口仅可在Stage模型下使用。

ClipboardPolicy

Phone12+PC/2in113+Tablet12+

设备剪贴板策略。

系统能力: SystemCapability.Customization.EnterpriseDeviceManager

模型约束: 此接口仅可在Stage模型下使用。

展开
名称 说明
DEFAULT 0 默认,表示无策略。
IN_APP 1 剪贴板可在同一应用使用。
LOCAL_DEVICE 2 剪贴板可在同一设备使用。
CROSS_DEVICE 3 剪贴板可跨设备使用。

ApplicationInstance20+

Phone20+PC/2in120+Tablet20+

应用实例。

系统能力: SystemCapability.Customization.EnterpriseDeviceManager

模型约束: 此接口仅可在Stage模型下使用。

展开
名称 类型 只读 可选 说明
appIdentifier string 应用唯一标识符,如果应用没有appIdentifier可使用appId代替,可以通过接口bundleManager.getBundleInfo获取bundleInfo.signatureInfo.appIdentifier和bundleInfo.signatureInfo.appId。
accountId number 用户ID,指定具体用户,取值范围:大于等于0。accountId可以通过@ohos.account.osAccount中的getOsAccountLocalId等接口来获取。
appIndex number

表示分身应用的索引,默认值为0。

appIndex为0时,表示主应用。appIndex大于0时,表示指定的分身应用。

PermissionManagedState20+

Phone20+PC/2in120+Tablet20+

应用权限的管理状态。

系统能力: SystemCapability.Customization.EnterpriseDeviceManager

模型约束: 此接口仅可在Stage模型下使用。

展开
名称 说明
DEFAULT 1 默认由用户授予。
GRANTED 0 已静默授予。
DENIED -1 已静默拒绝。

WatermarkProperties

Phone26.0.0+PC/2in126.0.0+Tablet26.0.0+

水印属性。

起始版本: 26.0.0

系统能力: SystemCapability.Customization.EnterpriseDeviceManager

模型约束: 此接口仅可在Stage模型下使用。

展开
名称 类型 只读 可选 说明
intervalsRow number 显示水印的行数。
intervalsCol number 显示水印的列数。

PasswordAlgs

Phone26.0.0+PC/2in126.0.0+Tablet26.0.0+

处理口令数据使用的加密算法。

起始版本: 26.0.0

系统能力: SystemCapability.Customization.EnterpriseDeviceManager

模型约束: 此接口仅可在Stage模型下使用。

展开
名称 说明
SCRYPT_HKDF_AES 0 SCRYPT-HKDF-AES组合加密算法。
SCRYPT_HKDF_SM4 1 SCRYPT-HKDF-SM4组合加密算法。
在 API参考 中进行搜索
请输入您想要搜索的关键词