@autional/api-audit
v0.4.1
Published
Autional Audit API — auto-generated TypeScript client from audit-service
Readme
@autional/api-audit
Autional Audit API — auto-generated TypeScript client from audit-service (73 functions).
Auto-generated by
python sdk/scripts/generate-api-packages.py. Do not edit by hand.
Functions
| Function | Method | Path | Description |
|----------|--------|------|-------------|
| getAdminAuditAlerts(client, params?) | GET | /admin/audit/alerts | 获取告警列表 |
| getAdminAuditAlertsByAlerts(client, alertId: string) | GET | /admin/audit/alerts/{alert_id} | 获取告警详情 |
| postAdminAuditAlertsAssignByAlerts(client, alertId: string, data: AssignAlertRequest) | POST | /admin/audit/alerts/{alert_id}/assign | 分配告警处理人 |
| putAdminAuditAlertsStatusByAlerts(client, alertId: string, data: UpdateAlertStatusRequest) | PUT | /admin/audit/alerts/{alert_id}/status | 更新告警状态 |
| getAdminAuditAnomalies(client, params?) | GET | /admin/audit/anomalies | 获取审计异常列表 |
| postAdminAuditAnomaliesDetect(client, data: Record<string, unknown>) | POST | /admin/audit/anomalies/detect | 触发异常检测 |
| getAdminAuditAnomaliesByAnomalies(client, anomalyId: string) | GET | /admin/audit/anomalies/{anomaly_id} | 获取异常详情 |
| postAdminAuditAnomaliesAssignByAnomalies(client, anomalyId: string, data: AssignAnomalyRequest) | POST | /admin/audit/anomalies/{anomaly_id}/assign | 分配异常分析师 |
| postAdminAuditAnomaliesCommentByAnomalies(client, anomalyId: string, data: AddAnomalyCommentRequest) | POST | /admin/audit/anomalies/{anomaly_id}/comment | 添加异常调查评论 |
| postAdminAuditAnomaliesLinkByAnomalies(client, anomalyId: string, data: LinkAnomalyRequest) | POST | /admin/audit/anomalies/{anomaly_id}/link | 关联异常到案件 |
| getAdminAuditAnomaliesRelatedByAnomalies(client, anomalyId: string) | GET | /admin/audit/anomalies/{anomaly_id}/related | 获取关联异常 |
| putAdminAuditAnomaliesStatusByAnomalies(client, anomalyId: string, data: UpdateAnomalyStatusRequest) | PUT | /admin/audit/anomalies/{anomaly_id}/status | 更新异常状态 |
| getAdminAuditAnomaliesTimelineByAnomalies(client, anomalyId: string) | GET | /admin/audit/anomalies/{anomaly_id}/timeline | 获取异常事件时间线 |
| postAdminAuditArchive(client, data: Record<string, unknown>) | POST | /admin/audit/archive | 归档审计日志 |
| getAdminAuditArchiveStatus(client) | GET | /admin/audit/archive/status | 获取归档状态 |
| getAdminAuditBillingEvents(client, params?) | GET | /admin/audit/billing-events | 查询计费事件审计日志 |
| getAdminAuditComplianceAiDecisions(client) | GET | /admin/audit/compliance/ai-decisions | 列表查询AI决策 |
| postAdminAuditComplianceAiDecisions(client, data: RecordAIDecisionRequest) | POST | /admin/audit/compliance/ai-decisions | 记录AI决策 |
| getAdminAuditComplianceAiDecisionsByAiDecisions(client, aiDecisionId: string) | GET | /admin/audit/compliance/ai-decisions/{ai_decision_id} | 查询AI决策详情 |
| getAdminAuditComplianceBreaches(client) | GET | /admin/audit/compliance/breaches | 列表查询违规通知 |
| postAdminAuditComplianceBreaches(client, data: CreateBreachNotificationRequest) | POST | /admin/audit/compliance/breaches | 创建违规通知 |
| getAdminAuditComplianceBreachesByBreaches(client, breachId: string) | GET | /admin/audit/compliance/breaches/{breach_id} | 查询违规通知详情 |
| getAdminAuditComplianceCleanupRecords(client) | GET | /admin/audit/compliance/cleanup-records | 列表查询清理记录 |
| postAdminAuditComplianceCleanupRecords(client, data: CreateCleanupRecordRequest) | POST | /admin/audit/compliance/cleanup-records | 创建清理记录 |
| getAdminAuditComplianceCleanupRecordsByCleanupRecords(client, cleanupRecordId: string) | GET | /admin/audit/compliance/cleanup-records/{cleanup_record_id} | 查询清理记录详情 |
| getAdminAuditComplianceCrossBorder(client) | GET | /admin/audit/compliance/cross-border | 列表查询跨境传输 |
| postAdminAuditComplianceCrossBorder(client, data: CreateCrossBorderTransferRequest) | POST | /admin/audit/compliance/cross-border | 创建跨境传输记录 |
| getAdminAuditComplianceCrossBorderByCrossBorder(client, crossBorderTransferId: string) | GET | /admin/audit/compliance/cross-border/{cross_border_transfer_id} | 查询跨境传输详情 |
| getAdminAuditComplianceDataClassifications(client) | GET | /admin/audit/compliance/data-classifications | 列表查询数据分类 |
| postAdminAuditComplianceDataClassifications(client, data: CreateDataClassificationRequest) | POST | /admin/audit/compliance/data-classifications | 创建数据分类 |
| getAdminAuditComplianceDataClassificationsByDataClassifications(client, dataClassificationId: string) | GET | /admin/audit/compliance/data-classifications/{data_classification_id} | 查询数据分类详情 |
| getAdminAuditCompliancePias(client) | GET | /admin/audit/compliance/pias | 列表查询 PIA |
| postAdminAuditCompliancePias(client, data: CreatePIARequest) | POST | /admin/audit/compliance/pias | 创建 PIA |
| getAdminAuditCompliancePiasByPias(client, piaId: string) | GET | /admin/audit/compliance/pias/{pia_id} | 查询 PIA 详情 |
| getAdminAuditComplianceRoleActions(client) | GET | /admin/audit/compliance/role-actions | 查询角色操作映射 |
| getAdminAuditComplianceSodRules(client, params?) | GET | /admin/audit/compliance/sod-rules | 查询SoD规则 |
| postAdminAuditExport(client, data: ExportJobRequest) | POST | /admin/audit/export | 导出审计日志 |
| getAdminAuditExportJobs(client, params?) | GET | /admin/audit/export/jobs | 列出导出任务 |
| getAdminAuditExportDownloadByExport(client, jobId: string) | GET | /admin/audit/export/{job_id}/download | 下载导出文件 |
| getAdminAuditExportStatusByExport(client, jobId: string) | GET | /admin/audit/export/{job_id}/status | 获取导出任务状态 |
| getAdminAuditHashchainByHashchain(client, tenantId: string) | GET | /admin/audit/hashchain/{tenant_id} | 获取哈希链信息 |
| getAdminAuditHashchainVerifyByDateByHashchain(client, tenantId: string, params?) | GET | /admin/audit/hashchain/{tenant_id}/verify-by-date | 按日期范围验证哈希链 |
| getAdminAuditIncidents(client, params?) | GET | /admin/audit/incidents | 获取安全事件列表 |
| postAdminAuditIncidents(client, data: CreateIncidentRequest) | POST | /admin/audit/incidents | 创建安全事件 |
| getAdminAuditIncidentsByIncidents(client, incidentId: string) | GET | /admin/audit/incidents/{incident_id} | 获取安全事件详情 |
| postAdminAuditIncidentsCommentByIncidents(client, incidentId: string, data: AddIncidentCommentRequest) | POST | /admin/audit/incidents/{incident_id}/comment | 添加安全事件评论 |
| putAdminAuditIncidentsStatusByIncidents(client, incidentId: string, data: UpdateIncidentStatusRequest) | PUT | /admin/audit/incidents/{incident_id}/status | 更新安全事件状态 |
| getAdminAuditLogs(client, params?) | GET | /admin/audit/logs | 查询审计日志 |
| getAdminAuditLogsByLogs(client, auditLogId: string) | GET | /admin/audit/logs/{audit_log_id} | 根据ID获取审计日志 |
| getAdminAuditMerkleProof(client, params?) | GET | /admin/audit/merkle-proof | 获取指定审计日志条目的 Merkle Proof |
| postAdminAuditMerkleProofs(client, data: MerkleProofsRequest) | POST | /admin/audit/merkle-proofs | 批量获取多个审计日志条目的 Merkle Proof |
| getAdminAuditMerkleRoot(client, params?) | GET | /admin/audit/merkle-root | 获取租户审计日志的 Merkle Root |
| getAdminAuditPaymentEvents(client, params?) | GET | /admin/audit/payment-events | 查询支付事件审计日志 |
| getAdminAuditReportsCompliance(client, params?) | GET | /admin/audit/reports/compliance | 获取合规审计报告 |
| getAdminAuditReportsSecurity(client, params?) | GET | /admin/audit/reports/security | 获取安全审计报告 |
| getAdminAuditRetentionPolicy(client, params?) | GET | /admin/audit/retention-policy | 获取租户审计日志保留策略 |
| putAdminAuditRetentionPolicy(client, data: RetentionPolicyRequest) | PUT | /admin/audit/retention-policy | 保存或更新租户审计日志保留策略 |
| getAdminAuditServerLogs(client, params?) | GET | /admin/audit/server-logs | 查询服务错误日志 |
| getAdminAuditServerLogsServices(client) | GET | /admin/audit/server-logs/services | 获取已记录日志的服务列表 |
| getAdminAuditSiemConnectors(client, params?) | GET | /admin/audit/siem/connectors | 列出 SIEM 连接器 |
| postAdminAuditSiemConnectors(client, data: SIEMConnectorRequest) | POST | /admin/audit/siem/connectors | 创建 SIEM 连接器 |
| deleteAdminAuditSiemConnectorsByConnectors(client, connectorId: string) | DELETE | /admin/audit/siem/connectors/{connector_id} | 删除 SIEM 连接器 |
| putAdminAuditSiemConnectorsByConnectors(client, connectorId: string, data: SIEMConnectorRequest) | PUT | /admin/audit/siem/connectors/{connector_id} | 更新 SIEM 连接器 |
| postAdminAuditSiemConnectorsTestByConnectors(client, connectorId: string) | POST | /admin/audit/siem/connectors/{connector_id}/test | 测试 SIEM 连接器 |
| getAdminAuditStats(client) | GET | /admin/audit/stats | 获取审计统计 |
| getAdminAuditTenantConfig(client) | GET | /admin/audit/tenant-config | 获取租户异常检测配置 |
| putAdminAuditTenantConfig(client, data: AuditTenantConfig) | PUT | /admin/audit/tenant-config | 更新租户异常检测配置 |
| getAdminAuditVerifications(client) | GET | /admin/audit/verifications | 查询最近一次自动哈希链验证结果 |
| postAdminAuditVerifications(client, data: Record<string, unknown>) | POST | /admin/audit/verifications | 验证哈希链完整性 |
| getAdminAuditWalletEvents(client, params?) | GET | /admin/audit/wallet-events | 查询钱包事件审计日志 |
| getAuditPublicHashchain(client) | GET | /audit/public/hashchain | 获取公开哈希链 |
| getAuditPublicLogsSummary(client) | GET | /audit/public/logs-summary | 获取公开日志摘要 |
| getAuditPublicStats(client) | GET | /audit/public/stats | 获取公开审计统计 |
Install
npm install @autional/core @autional/api-auditQuick Start
import { Autional, browserPlatform } from '@autional/core';
import { getAdminAuditStats } from '@autional/api-audit';
const autional = new Autional({
appId: 'my-app',
issuer: 'https://auth.example.com', // your Autional server URL
platform: browserPlatform,
});
await autional.initialize();
// 返回值已由 ApiClient 解包为载荷(不是 { code, data, message } 信封)
const result = await getAdminAuditStats(autional.api);
console.log(result);Conventions
- Every function takes the
ApiClientas its first argument (autional.api). - Field names convert automatically:
camelCaseat the call site,snake_caseon the wire. - Return values are unwrapped payloads, not
{ code, data, message }envelopes.
See the root SDK README for tokens, refresh, and OAuth flows.
