> ## Documentation Index
> Fetch the complete documentation index at: https://docs.hiperai.com/llms.txt
> Use this file to discover all available pages before exploring further.

# 監査ログ

> SMLTP監査ログの取得

# 監査ログ

セキュリティの監視とコンプライアンスのために 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`    | 文字列 | いいえ | -  | 説明またはメタデータの検索語            |

## リクエストの例

```bash theme={null}
GET /audit-logs?startDate=2024-01-01T00:00:00Z&endDate=2024-01-20T23:59:59Z&severity=info&limit=20
```

## 成功の応答

**ステータス コード**: `200 OK`

```json theme={null}
{
  "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

```javascript theme={null}
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);
```

### パイソン

```python theme={null}
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

```bash theme={null}
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 不正

```json theme={null}
{
  "success": false,
  "error": {
    "code": "UNAUTHORIZED",
    "message": "Invalid or missing API key"
  }
}
```

### 403 禁止

```json theme={null}
{
  "success": false,
  "error": {
    "code": "INSUFFICIENT_PERMISSIONS",
    "message": "Admin privileges required"
  }
}
```

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

```json theme={null}
{
  "success": false,
  "error": {
    "code": "RATE_LIMIT_EXCEEDED",
    "message": "Rate limit exceeded",
    "retryAfter": 60
  }
}
```

## フィルタリングの例

### 期間

```bash theme={null}
# 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
```

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

```bash theme={null}
# Get all SMLTP policy management events
GET /audit-logs?type=smltp_policy_management

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

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

```bash theme={null}
# 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 日間になります。
* 検索: 説明フィールドとメタデータ操作フィールドを検索します。
* ネストされた応答: 応答はデータ オブジェクトの下にネストされます。
* ユーザー情報: ユーザー情報は利用可能な場合に入力されます。
* ログはコンプライアンスの目的で保存されます


## OpenAPI

````yaml GET /audit-logs
openapi: 3.0.3
info:
  title: SecureAI External API
  description: >
    SecureAI External API provides AI chat completion and image generation
    capabilities with knowledge base retrieval, 

    security policies, and comprehensive usage tracking. This API is designed
    for external developers 

    and integrations using API key authentication.


    ## Key Features

    - **RAG (Retrieval-Augmented Generation)**: Automatically search knowledge
    bases for relevant context

    - **Multi-Model Support**: OpenAI, Anthropic, Google, Meta, and other AI
    models

    - **Model Redundancy & Failover**: Caller-defined failover chains (primary +
    fallbacks) with per-attempt timeouts

    - **OpenAI-Compatible Endpoint**: Point any OpenAI SDK at `/api/external/v1`
    — no code changes

    - **Image Generation**: Generate and edit images using Google Gemini 2.5
    Flash Image

    - **Speech-to-Speech (S2S)**: Real-time voice conversations using OpenAI
    Realtime API with WebRTC

    - **Security Policies**: SMLTP policy enforcement, per-call Prompt Shield,
    and signed compliance receipts

    - **Usage Tracking**: Comprehensive usage monitoring, self-service quota,
    and rate limiting

    - **Knowledge Base Integration**: Access to personal and shared knowledge
    bases

    - **User Management**: Complete user, group, and role management
    capabilities

    - **Audit Logging**: Comprehensive activity and security audit logs


    ## Authentication

    All endpoints (except health check) require API key authentication using
    Bearer token:

    ```

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

    ```


    ## Billing and Usage

    By default, API requests are billed to the user account that owns the API
    key. You can specify 

    a different user to bill by including the `user_id` parameter in your
    request. This allows for:

    - Multi-tenant applications with per-user billing

    - Flexible completion limit management

    - Per-user "Usage by Model" settings


    ## Rate Limits

    - Default: 60 requests per minute, 1000 requests per hour

    - Daily limits: 100 requests (configurable)

    - Monthly limits: 10,000 requests (configurable)


    ## Base URL

    ```

    https://secureai.hiperai.ai/api/external

    ```
  version: 1.1.0
  contact:
    name: SecureAI Support
    email: support@secureai.hiperai.ai
  license:
    name: Proprietary
    url: https://secureai.hiperai.ai/terms
servers:
  - url: https://secureai.hiperai.ai/api/external
    description: Production server
  - url: http://localhost:3010/api/external
    description: Development server
security:
  - ApiKeyAuth: []
tags:
  - name: System
    description: System health and status endpoints
  - name: Discovery
    description: Endpoints to discover available models, indexes, and policies
  - name: Chat
    description: AI chat completion endpoints
  - name: User Management
    description: Endpoints for managing user accounts and roles
  - name: Index Management
    description: Endpoints for managing knowledge base indexes
  - name: Group Management
    description: Endpoints for managing user groups
  - name: SMLTP Security
    description: Endpoints for managing SMLTP security policies and audit logs
  - name: Role Management
    description: Endpoints for managing user roles
  - name: Activity Logs
    description: Endpoints for retrieving activity logs
externalDocs:
  description: SecureAI Documentation
  url: https://secureai.hiperai.ai/docs
paths:
  /audit-logs:
    get:
      tags:
        - SMLTP Security
      summary: Get SMLTP Audit Logs
      description: >
        Retrieve SMLTP audit logs with filtering. Only accessible by
        administrators.
      parameters:
        - name: page
          in: query
          description: Page number for pagination
          required: false
          schema:
            type: integer
            default: 1
            minimum: 1
        - name: limit
          in: query
          description: Number of logs per page
          required: false
          schema:
            type: integer
            default: 50
            minimum: 1
            maximum: 100
        - name: startDate
          in: query
          description: Start date for filtering (ISO 8601 format)
          required: false
          schema:
            type: string
            format: date-time
        - name: endDate
          in: query
          description: End date for filtering (ISO 8601 format)
          required: false
          schema:
            type: string
            format: date-time
        - name: type
          in: query
          description: Filter by log type
          required: false
          schema:
            type: string
        - name: severity
          in: query
          description: Filter by severity level
          required: false
          schema:
            type: string
            enum:
              - info
              - warning
              - error
              - critical
        - name: userId
          in: query
          description: Filter by user ID
          required: false
          schema:
            type: string
        - name: search
          in: query
          description: Search term for description or metadata
          required: false
          schema:
            type: string
      responses:
        '200':
          description: SMLTP audit logs
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    example: true
                  data:
                    type: object
                    properties:
                      logs:
                        type: array
                        items:
                          type: object
                          properties:
                            id:
                              type: string
                              example: 60a7c8f5e8b4f5001f7a8c23
                            timestamp:
                              type: string
                              format: date-time
                              example: '2024-01-15T10:30:00.000Z'
                            type:
                              type: string
                              example: smltp_policy_management
                            severity:
                              type: string
                              example: info
                            description:
                              type: string
                              example: >-
                                External API: Created new SMLTP policy Custom
                                Policy
                            user:
                              type: object
                              nullable: true
                              properties:
                                id:
                                  type: string
                                  example: 60a7c8f5e8b4f5001f7a8c24
                                name:
                                  type: string
                                  example: John Doe
                                email:
                                  type: string
                                  example: john@example.com
                            metadata:
                              type: object
                              description: Additional metadata
                            complianceCategory:
                              type: string
                              example: data_protection
                            outcome:
                              type: string
                              example: success
                      pagination:
                        type: object
                        properties:
                          page:
                            type: integer
                            example: 1
                          limit:
                            type: integer
                            example: 50
                          total:
                            type: integer
                            example: 150
                          pages:
                            type: integer
                            example: 3
                      dateRange:
                        type: object
                        properties:
                          startDate:
                            type: string
                            format: date-time
                            example: '2024-01-08T10:30:00.000Z'
                          endDate:
                            type: string
                            format: date-time
                            example: '2024-01-15T10:30:00.000Z'
        '401':
          description: Invalid API key
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: Access denied - admin only
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      security:
        - ApiKeyAuth: []
components:
  schemas:
    ErrorResponse:
      type: object
      properties:
        success:
          type: boolean
          example: false
        error:
          type: string
          example: Invalid API key
        message:
          type: string
          example: The provided API key is invalid or has been revoked
        request_id:
          type: string
          example: req-abc123
          description: Request ID for tracking (if available)
  securitySchemes:
    ApiKeyAuth:
      type: http
      scheme: bearer
      description: |
        API key authentication using Bearer token format.
        Example: `Authorization: Bearer sk-your-api-key-here`

````