Get SMLTP Audit Logs

curl --request GET \
  --url https://secureai.hiperai.ai/api/external/audit-logs \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://secureai.hiperai.ai/api/external/audit-logs', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "success": true,
  "data": {
    "logs": [
      {
        "id": "60a7c8f5e8b4f5001f7a8c23",
        "timestamp": "2024-01-15T10:30:00.000Z",
        "type": "smltp_policy_management",
        "severity": "info",
        "description": "External API: Created new SMLTP policy Custom Policy",
        "user": {
          "id": "60a7c8f5e8b4f5001f7a8c24",
          "name": "John Doe",
          "email": "john@example.com"
        },
        "metadata": {},
        "complianceCategory": "data_protection",
        "outcome": "success"
      }
    ],
    "pagination": {
      "page": 1,
      "limit": 50,
      "total": 150,
      "pages": 3
    },
    "dateRange": {
      "startDate": "2024-01-08T10:30:00.000Z",
      "endDate": "2024-01-15T10:30:00.000Z"
    }
  }
}

{
  "success": false,
  "error": "Invalid API key",
  "message": "The provided API key is invalid or has been revoked",
  "request_id": "req-abc123"
}

{
  "success": false,
  "error": "Invalid API key",
  "message": "The provided API key is invalid or has been revoked",
  "request_id": "req-abc123"
}

GET

audit-logs

Get SMLTP Audit Logs

curl --request GET \
  --url https://secureai.hiperai.ai/api/external/audit-logs \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://secureai.hiperai.ai/api/external/audit-logs', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "success": true,
  "data": {
    "logs": [
      {
        "id": "60a7c8f5e8b4f5001f7a8c23",
        "timestamp": "2024-01-15T10:30:00.000Z",
        "type": "smltp_policy_management",
        "severity": "info",
        "description": "External API: Created new SMLTP policy Custom Policy",
        "user": {
          "id": "60a7c8f5e8b4f5001f7a8c24",
          "name": "John Doe",
          "email": "john@example.com"
        },
        "metadata": {},
        "complianceCategory": "data_protection",
        "outcome": "success"
      }
    ],
    "pagination": {
      "page": 1,
      "limit": 50,
      "total": 150,
      "pages": 3
    },
    "dateRange": {
      "startDate": "2024-01-08T10:30:00.000Z",
      "endDate": "2024-01-15T10:30:00.000Z"
    }
  }
}

{
  "success": false,
  "error": "Invalid API key",
  "message": "The provided API key is invalid or has been revoked",
  "request_id": "req-abc123"
}

{
  "success": false,
  "error": "Invalid API key",
  "message": "The provided API key is invalid or has been revoked",
  "request_id": "req-abc123"
}

監査ログ

セキュリティの監視とコンプライアンスのために SMLTP (Secure Model Language Transfer Protocol) 監査ログを取得します。

エンドポイント

GET /audit-logs

説明

このエンドポイントは、セキュリティイベント、ポリシー違反、コンプライアンス活動を追跡する SMLTP 監査ログを返します。これは、セキュリティ監視、コンプライアンス監査、セキュリティインシデントの調査に役立ちます。

認証

必須: 管理者権限を持つ API キー

Authorization: Bearer sk-your-api-key-here

クエリパラメータ

パラメータ	タイプ	必須	説明
`page`	整数	いいえ	1	ページネーションのページ番号 (デフォルト: 1)
`limit`	整数	いいえ	50	ページごとのログの数 (デフォルト: 50)
`startDate`	文字列	いいえ	-	フィルタリングの開始日 (ISO 8601 形式)
`endDate`	文字列	いいえ	-	フィルタリングの終了日 (ISO 8601 形式)
`type`	文字列	いいえ	-	ログの種類でフィルターする
`severity`	文字列	いいえ	-	重大度レベルでフィルターする
`userId`	文字列	いいえ	-	ユーザー ID によるフィルター
`search`	文字列	いいえ	-	説明またはメタデータの検索語

リクエストの例

GET /audit-logs?startDate=2024-01-01T00:00:00Z&endDate=2024-01-20T23:59:59Z&severity=info&limit=20

成功の応答

ステータスコード: 200 OK

{
  "success": true,
  "data": {
    "logs": [
      {
        "id": "60a7c8f5e8b4f5001f7a8c23",
        "timestamp": "2024-01-15T10:30:00.000Z",
        "type": "smltp_policy_management",
        "severity": "info",
        "description": "External API: Created new SMLTP policy Custom Policy",
        "user": {
          "id": "60a7c8f5e8b4f5001f7a8c24",
          "name": "John Doe",
          "email": "john@example.com"
        },
        "metadata": {
          "endpoint": "/api/external/smltp-policies",
          "policyId": "custom-policy",
          "policyName": "Custom Policy",
          "setAsActive": false,
          "apiKeyId": "60a7c8f5e8b4f5001f7a8c25"
        },
        "complianceCategory": "data_protection",
        "outcome": "success"
      }
    ],
    "pagination": {
      "page": 1,
      "limit": 50,
      "total": 150,
      "pages": 3
    },
    "dateRange": {
      "startDate": "2024-01-08T10:30:00.000Z",
      "endDate": "2024-01-15T10:30:00.000Z"
    }
  }
}

応答フィールド

フィールド	タイプ	説明
`success`	ブール値	操作が成功したかどうかを示します。
`data`	オブジェクト	応答データオブジェクト
`data.logs`	配列	監査ログオブジェクトの配列
`data.logs[].id`	文字列	一意の監査ログ識別子
`data.logs[].timestamp`	文字列	ログのタイムスタンプ (ISO 8601)
`data.logs[].type`	文字列	監査イベントの種類
`data.logs[].severity`	文字列	重大度レベル
`data.logs[].description`	文字列	イベントの説明
`data.logs[].user`	オブジェクト	ユーザー情報 (入手可能な場合)
`data.logs[].user.id`	文字列	ユーザーID
`data.logs[].user.name`	文字列	ユーザー名
`data.logs[].user.email`	文字列	ユーザーのメールアドレス
`data.logs[].metadata`	オブジェクト	追加のメタデータ
`data.logs[].complianceCategory`	文字列	コンプライアンスカテゴリ
`data.logs[].outcome`	文字列	イベントの結果
`data.pagination`	オブジェクト	ページネーション情報
`data.pagination.page`	整数	現在のページ番号
`data.pagination.limit`	整数	ページごとの項目
`data.pagination.total`	整数	ログの総数
`data.pagination.pages`	整数	総ページ数
`data.dateRange`	オブジェクト	日付範囲情報

使用例

JavaScript

const getAuditLogs = async (params = {}) => {
  const queryString = new URLSearchParams(params).toString();
  const url = `https://{customer.name}.hiperai.ai/api/external/audit-logs${queryString ? `?${queryString}` : ''}`;
  
  const response = await fetch(url, {
    method: 'GET',
    headers: {
      'Authorization': 'Bearer sk-your-api-key-here'
    }
  });
  
  return await response.json();
};

// Example usage
const result = await getAuditLogs({
  startDate: '2024-01-01T00:00:00Z',
  endDate: '2024-01-20T23:59:59Z',
  severity: 'info',
  limit: 20
});
console.log(result.data.logs);

パイソン

import requests

def get_audit_logs(params=None):
    url = "https://{customer.name}.hiperai.ai/api/external/audit-logs"
    headers = {
        "Authorization": "Bearer sk-your-api-key-here"
    }
    
    response = requests.get(url, headers=headers, params=params)
    return response.json()

# Example usage
params = {
    "startDate": "2024-01-01T00:00:00Z",
    "endDate": "2024-01-20T23:59:59Z",
    "severity": "info",
    "limit": 20
}

result = get_audit_logs(params)
print(result["data"]["logs"])

cURL

curl -X GET "https://{customer.name}.hiperai.ai/api/external/audit-logs?startDate=2024-01-01T00:00:00Z&endDate=2024-01-20T23:59:59Z&severity=info&limit=20" \
  -H "Authorization: Bearer sk-your-api-key-here"

エラー応答

401 不正

{
  "success": false,
  "error": {
    "code": "UNAUTHORIZED",
    "message": "Invalid or missing API key"
  }
}

403 禁止

{
  "success": false,
  "error": {
    "code": "INSUFFICIENT_PERMISSIONS",
    "message": "Admin privileges required"
  }
}

429 リクエストが多すぎます

{
  "success": false,
  "error": {
    "code": "RATE_LIMIT_EXCEEDED",
    "message": "Rate limit exceeded",
    "retryAfter": 60
  }
}

フィルタリングの例

期間

# Get logs from last 7 days
GET /audit-logs?startDate=2024-01-13T00:00:00Z&endDate=2024-01-20T23:59:59Z

# Get logs from specific date
GET /audit-logs?startDate=2024-01-20T00:00:00Z&endDate=2024-01-20T23:59:59Z

イベントのフィルタリング

# Get all SMLTP policy management events
GET /audit-logs?type=smltp_policy_management

# Get info level events
GET /audit-logs?severity=info

ユーザーのフィルタリング

# Get logs for specific user
GET /audit-logs?userId=60a7c8f5e8b4f5001f7a8c24

# Search in descriptions
GET /audit-logs?search=policy

使用例

セキュリティ監視: セキュリティイベントとポリシー違反を監視します。
コンプライアンス監査: コンプライアンス活動と違反を追跡します。
インシデント調査: セキュリティインシデントと侵害を調査します。
ポリシー分析: ポリシーの有効性と施行を分析します。
ユーザーアクティビティ: ユーザーアクションと API 使用状況を追跡します。

レート制限

デフォルト: 1 分あたり 100 リクエスト
毎日: 1 日あたり 10,000 リクエスト
毎月: 毎月 300,000 件のリクエスト

注意事項

このエンドポイントには管理者権限が必要です
ページネーション: オフセットではなくページパラメータを使用します。
日付範囲: 日付が指定されていない場合、デフォルトで過去 7 日間になります。
検索: 説明フィールドとメタデータ操作フィールドを検索します。
ネストされた応答: 応答はデータオブジェクトの下にネストされます。
ユーザー情報: ユーザー情報は利用可能な場合に入力されます。
ログはコンプライアンスの目的で保存されます

承認

Authorization

string

header

必須

API key authentication using Bearer token format. Example: Authorization: Bearer sk-your-api-key-here

クエリパラメータ

page

integer

デフォルト:1

Page number for pagination

必須範囲: x >= 1

limit

integer

デフォルト:50

Number of logs per page

必須範囲: 1 <= x <= 100

startDate

string<date-time>

Start date for filtering (ISO 8601 format)

endDate

string<date-time>

End date for filtering (ISO 8601 format)

type

string

Filter by log type

severity

enum<string>

Filter by severity level

利用可能なオプション:

info,

warning,

error,

critical

userId

string

Filter by user ID

string

Search term for description or metadata

レスポンス

SMLTP audit logs

success

boolean

例:

true

data

object

Show child attributes

導入 & セットアップ

モデル & AI 生成

ナレッジベース & RAG

セキュリティ、ガードレール & 監査

ユーザー & アクセス (IAM)

請求、クォータ & Webhook

監査ログ

監査ログ

エンドポイント

説明

認証

クエリパラメータ

リクエストの例

成功の応答

応答フィールド

使用例

JavaScript

パイソン

cURL

エラー応答

401 不正

403 禁止

429 リクエストが多すぎます

フィルタリングの例

期間

イベントのフィルタリング

ユーザーのフィルタリング

使用例

レート制限

注意事項

承認

クエリパラメータ

レスポンス

​監査ログ

​エンドポイント

​説明

​認証

​クエリパラメータ

​リクエストの例

​成功の応答

​応答フィールド

​使用例

​JavaScript

​パイソン

​cURL

​エラー応答

​401 不正

​403 禁止

​429 リクエストが多すぎます

​フィルタリングの例

​期間

​イベントのフィルタリング

​ユーザーのフィルタリング

​使用例

​レート制限

​注意事項

承認

クエリパラメータ

レスポンス

監査ログ

エンドポイント

説明

認証

クエリパラメータ

リクエストの例

成功の応答

応答フィールド

使用例

JavaScript

パイソン

cURL

エラー応答

401 不正

403 禁止

429 リクエストが多すぎます

フィルタリングの例

期間

イベントのフィルタリング

ユーザーのフィルタリング

使用例

レート制限

注意事項