監査ログのリスト表示（管理者向け） - AI Coding Assistant Lingma

組織管理者は、この API を呼び出して監査ログをクエリできます。

対応エディション

Enterprise Dedicated Edition

サービスエンドポイントと承認情報

API リクエスト構文の <domain> をエンドポイントに置き換えるサービスエンドポイントを取得します。
アクセストークンを取得します。
organizationId を取得します。 Lingma コンソールに移動し、[企業設定] > > [組織] の下の [基本情報] ページで組織 ID を確認します。

製品	リソース	必要な権限
組織設定	監査ログ	読み取り専用

リクエスト構文

GET https://{domain}/oapi/v1/platform/auditLogs

リクエストヘッダー

パラメーター	タイプ	必須	説明	例
x-yunxiao-token	文字列	はい	アクセストークン。	pt-0fh3**0fbG_35af**0484

リクエストパラメーター

パラメーター	タイプ	位置	必須	説明	例
`organizationId`	文字列	パス	いいえ	組織レベルでログをフィルタリングする組織の ID。	99d1****6124
`userIds`	文字列	クエリ	いいえ	監査ログでフィルタリングするユーザー ID のカンマ区切りリスト。	99d1****6124
`apps`	文字列	クエリ	いいえ	カンマ区切りのアプリケーション ID リスト (例: `lingma`) で、これらのアプリケーションのログをフィルタリングします。	Example Application Name
`scope`	文字列	クエリ	いいえ	ログの範囲: `SCOPE_SITE`: 企業レベルのログをクエリします。 `SCOPE_ORG`: 組織レベルのログをクエリします。	SCOPE_SITE
`actionTimeStart`	文字列	クエリ	はい	ログ検索範囲の開始タイムスタンプ（RFC3339 形式）（包含）。	2023-08-31T03:59:16.201Z
`actionTimeEnd`	文字列	クエリ	いいえ	ログ検索範囲の終了タイムスタンプ（RFC3339 形式）（排他）。指定しない場合、デフォルトは現在の時刻です。	2023-08-31T03:59:16.201Z
`perPage`	整数	クエリ	いいえ	1 ページあたりに返す監査ログエントリの数。有効値: 1～100。デフォルト: 100。	20
`nextToken`	文字列	クエリ	いいえ	ページネーショントークン。最初の呼び出しの後、このトークンを使用して次の結果セットをクエリします。

サンプルリクエスト

curl -X 'GET' \
  'https://{domain}/oapi/v1/platform/auditLogs?organizationId={organizationId}&userIds={userIds}&apps={apps}&scope={scope}&actionTimeStart={actionTimeStart}&actionTimeEnd={actionTimeEnd}&perPage={perPage}&nextToken={nextToken}' \
  -H 'Content-Type: application/json' \
  -H 'x-yunxiao-token: pt-0fh3****0fbG_35af****0484'

レスポンスパラメーター

パラメーター	タイプ	説明	例
-	配列
-	オブジェクト
`action`	文字列	ユーザーが実行した操作（ログイン、ユーザーの作成、ユーザーの削除など）。	login
`actionTime`	文字列	操作が発生した時刻。	2023-08-31T03:59:16.201Z
`app`	オブジェクト	アプリケーション情報。
`identity`	文字列	アプリケーション ID。	base
`name`	文字列	アプリケーション名。	Example Application Name
`appId`	文字列	一意のアプリケーション ID。	99d1****6124
`detail`	文字列	操作の詳細。	xxx login
`id`	文字列	一意の監査ログ ID。	99d1****6124
`ip`	文字列	操作が実行された IP アドレス。	192...1
`organization`	オブジェクト	組織情報。
`id`	文字列	組織 ID。	99d1****6124
`name`	文字列	組織名。	Example Name
`organizationId`	文字列	組織 ID。	99d1****6124
`scope`	文字列	操作の範囲。	org
`targetId`	文字列	操作が実行されたオブジェクトの ID。	99d1****6124
`targetType`	文字列	操作が実行されたオブジェクトのタイプ。	user
`user`	オブジェクト	オペレーター情報。
`id`	文字列	ユーザー ID。	99d1****6124
`name`	文字列	ユーザーのユーザー名。	Example Name
`nickName`	文字列	ユーザーのニックネームまたはエイリアス。	Example Nickname
`userId`	文字列	ユーザー ID。	99d1****6124

正常なレスポンスの例

[
    {
        "action": "login",
        "actionTime": "2023-08-31T03:59:16.201Z",
        "app": {
            "identity": "base",
            "name": "Example Application Name"
        },
        "appId": "99d1****6124",
        "detail": "xxx login",
        "id": "99d1****6124",
        "ip": "192.*.*.1",
        "organization": {
            "id": "99d1****6124",
            "name": "Example Name"
        },
        "organizationId": "99d1****6124",
        "scope": "org",
        "targetId": "99d1****6124",
        "targetType": "user",
        "user": {
            "id": "99d1****6124",
            "name": "Example Name",
            "nickName": "Example Nickname"
        },
        "userId": "99d1****6124"
    }
]

レスポンスヘッダー

パラメーター	説明	例
`x-next-token`	次のページのトークンです。

エラーコード

詳細については、「エラーコード」をご参照ください。