1# @ohos.enterprise.securityManager（安全管理）(系统接口) 2 3本模块提供设备安全管理的能力，包括查询安全补丁状态、查询文件加密状态等。 4 5> **说明：** 6> 7> 本模块首批接口从API version 11开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 8> 9> 本模块接口仅可在Stage模型下使用。 10> 11> 本模块接口仅对[设备管理应用](../../mdm/mdm-kit-guide.md#功能介绍)开放，需将[设备管理应用激活](js-apis-enterprise-adminManager-sys.md#adminmanagerenableadmin)后调用，实现相应功能。 12> 13> 当前页面仅包含本模块的系统接口，其他公开接口参见。其他公开接口参见[@ohos.enterprise.securityManager](js-apis-enterprise-securityManager.md)。 14 15## 导入模块 16 17```ts 18import { securityManager } from '@kit.MDMKit'; 19``` 20 21## securityManager.getSecurityPatchTag 22 23getSecurityPatchTag(admin: Want): string 24 25以同步方法查询设备安全补丁Tag。成功返回安全补丁Tag，失败抛出对应异常。 26 27**需要权限：** ohos.permission.ENTERPRISE_MANAGE_SECURITY 28 29**系统能力：** SystemCapability.Customization.EnterpriseDeviceManager 30 31**系统API：** 此接口为系统接口。 32 33**参数：** 34 35| 参数名 | 类型 | 必填 | 说明 | 36| ----- | ----------------------------------- | ---- | ------- | 37| admin | [Want](../apis-ability-kit/js-apis-app-ability-want.md) | 是 | 设备管理应用。 | 38 39**返回值：** 40 41| 类型 | 说明 | 42| --------------------- | ------------------------- | 43| string | 补丁Tag结果，返回补丁Tag字符串。 | 44 45**错误码**： 46 47以下错误码的详细介绍请参见[企业设备管理错误码](errorcode-enterpriseDeviceManager.md)和[通用错误码](../errorcode-universal.md)。 48 49| 错误码ID | 错误信息 | 50| ------- | ---------------------------------------------------------------------------- | 51| 9200001 | The application is not an administrator application of the device. | 52| 9200002 | The administrator application does not have permission to manage the device. | 53| 201 | Permission verification failed. The application does not have the permission required to call the API. | 54| 202 | Permission verification failed. A non-system application calls a system API. | 55| 401 | Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. | 56 57**示例：** 58 59```ts 60import { Want } from '@kit.AbilityKit'; 61 62let wantTemp: Want = { 63 bundleName: 'com.example.myapplication', 64 abilityName: 'EntryAbility', 65}; 66 67try { 68 let res: string = securityManager.getSecurityPatchTag(wantTemp); 69 console.info(`Succeeded in getting security patch tag. tag: ${res}`); 70} catch(err) { 71 console.error(`Failed to get security patch tag. Code: ${err.code}, message: ${err.message}`); 72} 73``` 74## securityManager.getDeviceEncryptionStatus 75 76getDeviceEncryptionStatus(admin: Want): DeviceEncryptionStatus 77 78以同步方法查询设备文件系统加密状态。成功返回设备文件系统加密状态，失败抛出对应异常。 79 80**需要权限：** ohos.permission.ENTERPRISE_MANAGE_SECURITY 81 82**系统能力：** SystemCapability.Customization.EnterpriseDeviceManager 83 84**系统API：** 此接口为系统接口。 85 86**参数：** 87 88| 参数名 | 类型 | 必填 | 说明 | 89| -------- | ---------------------------------------- | ---- | ------------------------------- | 90| admin | [Want](../apis-ability-kit/js-apis-app-ability-want.md) | 是 | 设备管理应用。 | 91 92**返回值：** 93 94| 类型 | 说明 | 95| ---------------------- | ------------------------------------------------------ | 96| DeviceEncryptionStatus | 文件加密状态结构体，现只含有是否进行加密字段（bool）。 | 97 98**错误码**： 99 100以下错误码的详细介绍请参见[企业设备管理错误码](errorcode-enterpriseDeviceManager.md)和[通用错误码](../errorcode-universal.md)。 101 102| 错误码ID | 错误信息 | 103| ------- | ---------------------------------------------------------------------------- | 104| 9200001 | The application is not an administrator application of the device. | 105| 9200002 | The administrator application does not have permission to manage the device. | 106| 201 | Permission verification failed. The application does not have the permission required to call the API. | 107| 202 | Permission verification failed. A non-system application calls a system API. | 108| 401 | Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. | 109 110**示例：** 111 112```ts 113import { Want } from '@kit.AbilityKit'; 114let wantTemp: Want = { 115 bundleName: 'com.example.myapplication', 116 abilityName: 'EntryAbility', 117}; 118 119try { 120 let result: securityManager.DeviceEncryptionStatus = securityManager.getDeviceEncryptionStatus(wantTemp); 121 console.info(`Succeeded in getting device encryption status. isEncrypted: ${result.isEncrypted}`); 122} catch(err) { 123 console.error(`Failed to get device encryption status. Code: ${err.code}, message: ${err.message}`); 124} 125``` 126 127## securityManager.getPasswordPolicy<sup>12+</sup> 128 129getPasswordPolicy(): PasswordPolicy 130 131获取设备口令策略。 132 133**系统能力：** SystemCapability.Customization.EnterpriseDeviceManager 134 135**系统API：** 此接口为系统接口。 136 137**返回值：** 138 139| 类型 | 说明 | 140| --------------------- | ------------------------- | 141| [PasswordPolicy](./js-apis-enterprise-securityManager.md#passwordpolicy) | 设备口令策略。 | 142 143**错误码**： 144 145以下错误码的详细介绍请参见[通用错误码](../errorcode-universal.md)。 146 147| 错误码ID | 错误信息 | 148| ------- | ---------------------------------------------------------------------------- | 149| 202 | Permission verification failed. A non-system application calls a system API. | 150 151**示例：** 152 153```ts 154try { 155 let result: securityManager.PasswordPolicy = securityManager.getPasswordPolicy(); 156 console.info(`Succeeded in getting password policy, result : ${JSON.stringify(result)}`); 157} catch(err) { 158 console.error(`Failed to get password policy. Code: ${err.code}, message: ${err.message}`); 159} 160``` 161 162## DeviceEncryptionStatus 163 164设备管理应用的文件系统加密状态。 165 166**系统能力：** SystemCapability.Customization.EnterpriseDeviceManager 167 168**系统API**: 此接口为系统接口。 169 170| 名称 | 类型 | 必填 | 说明 | 171| ----------- | --------| ---- | ------------------------------- | 172| isEncrypted | boolean | 是 | 表示设备的文件系统是否加密。true:表示已加密 false:表示未加密 | 173