目录

SecurityAudit

Unified security audit data subscription and unsubscription APIs are provided for apps to obtain security audit data on a device.

Start version: 5.0.0(12)

Module Import

import { securityAudit } from '@kit.DeviceSecurityKit';

AuditEventInfo

Request parameter of the subscription or unsubscription API.

System capability: SystemCapability.Security.SecurityAudit

Start version: 5.0.0(12)

Name

Type

Read-only

Optional

Description

eventId

number

No

No

Audit event ID, which specifies the security audit data to be obtained. Example: 0x810800800.

The value range of the audit event ID is [0, 0xFFFFFFFFF].

AuditEvent

Security audit data.

System capability: SystemCapability.Security.SecurityAudit

Start version: 5.0.0(12)

Name

Type

Read-only

Optional

Description

eventId

number

No

No

Audit event ID, which is the same as that in the request.

version

string

No

Yes

Audit event version number.

timestamp

string

No

Yes

Time when an audit event occurs. The value is in YYYYMMDDHHMMSS format.

content

string

No

Yes

Audit event content. Different audit events have different contents. The value is a JSON string, for example, {"type": 1}.

userId

number

No

Yes

Sign-in user ID when an audit event occurs.

deviceId

string

No

Yes

ID of the device where an audit event occurs.

on("auditEventOccur")

on(type: 'auditEventOccur', auditEventInfo: AuditEventInfo, callback: Callback<AuditEvent>)

Subscribes to security audit data.

Required permission: ohos.permission.QUERY_AUDIT_EVENT

System capability: SystemCapability.Security.SecurityAudit

Start version: 5.0.0(12)

Parameters:

Parameter

Type

Mandatory

Description

type

string

Yes

Subscribed event type. This parameter has a fixed value of auditEventOccur, indicating audit events.

auditEventInfo

AuditEventInfo

Yes

Subscribed audit data.

callback

Callback<AuditEvent>

Yes

Callback function for receiving audit events.

Error codes:

For details about the error codes, please refer to ArkTS API Error Codes.

Error Code

Message

201

check permission fail.

401

invalid parameters.

Example:

import { securityAudit } from '@kit.DeviceSecurityKit';
import { BusinessError} from '@kit.BasicServicesKit';
import { hilog } from '@kit.PerformanceAnalysisKit';

const TAG = "SecurityAuditAuditJsTest";
const callback = (event: securityAudit.AuditEvent) => {
  hilog.info(0x0000, TAG, '%{public}s', 'Security_SecurityAudit_JsApi_Func eventId= ' + event.eventId);
  hilog.info(0x0000, TAG, '%{public}s', 'Security_SecurityAudit_JsApi_Func version= ' + event.version);
  hilog.info(0x0000, TAG, '%{public}s', 'Security_SecurityAudit_JsApi_Func content= ' + event.content);
  hilog.info(0x0000, TAG, '%{public}s', 'Security_SecurityAudit_JsApi_Func timestamp= ' + event.timestamp);
  hilog.info(0x0000, TAG, '%{public}s', 'Security_SecurityAudit_JsApi_Func userId= ' + event.userId);
  hilog.info(0x0000, TAG, '%{public}s', 'Security_SecurityAudit_JsApi_Func deviceId= ' + event.deviceId);
};
let auditEventInfo: securityAudit.AuditEventInfo = {
   eventId: 0x810800800
};

try {
  hilog.info(0x0000, TAG, 'on begin.');
  securityAudit.on('auditEventOccur', auditEventInfo, callback);
  hilog.info(0x0000, TAG, 'Succeeded in on.');
} catch (err) {
  let e: BusinessError = err as BusinessError;
  hilog.error(0x0000, TAG, 'on failed: %{public}d %{public}s', e.code, e.message);
}

off("auditEventOccur")

off(type: 'auditEventOccur', auditEventInfo: AuditEventInfo, callback?: Callback<AuditEvent>)

Unsubscribes from security audit data.

Required permission: ohos.permission.QUERY_AUDIT_EVENT

System capability: SystemCapability.Security.SecurityAudit

Start version: 5.0.0(12)

Parameters:

Parameter

Type

Mandatory

Description

type

string

Yes

Unsubscribed event type. This parameter has a fixed value of auditEventOccur, indicating audit events.

auditEventInfo

AuditEventInfo

Yes

Unsubscribed audit data.

callback

Callback<AuditEvent>

No

Callback function for receiving audit data. If a callback is passed, the subscription to this callback is canceled. If no callback is passed, subscriptions to all callbacks are canceled.

Error codes:

For details about the error codes, please refer to ArkTS API Error Codes.

Error Code

Message

201

check permission fail.

401

invalid parameters.

Example:

import { securityAudit } from '@kit.DeviceSecurityKit';
import { BusinessError} from '@kit.BasicServicesKit';
import { hilog } from '@kit.PerformanceAnalysisKit';

const TAG = "SecurityAuditAuditJsTest";
let auditEventInfo: securityAudit.AuditEventInfo = {
   eventId: 0x810800800
};

try {
  hilog.info(0x0000, TAG, 'off begin.');
  securityAudit.off('auditEventOccur', auditEventInfo);
  hilog.info(0x0000, TAG, 'Succeeded in off.');
} catch (err) {
  let e: BusinessError = err as BusinessError;
  hilog.error(0x0000, TAG, 'off failed: %{public}d %{public}s', e.code, e.message);
}