REST API

Content Hub開発者
REST API
エンドポイントの監査

エンドポイントの監査

日本語翻訳に関する免責事項

このページの翻訳はAIによって自動的に行われました。可能な限り正確な翻訳を心掛けていますが、原文と異なる表現や解釈が含まれる場合があります。正確で公式な情報については、必ず英語の原文をご参照ください。

監査インデックスのクエリに使用できるエンドポイントのリストは、/api/auditにあります。

メモ

また、コマンドラインインターフェイス(CLI)と特にtailコマンドを使用して、ログをクエリすることもできます。

クエリ

エンドポイントのベースアドレステンプレートは次のとおりです。

GET /api/audit/<INDEX_NAME>/query{/entityId}{?from,to,fullText,skip,take,sort,order}

クエリエンドポイントは、次のパラメータをサポートします。

名前	種類	サンプル値	形容
entityId	長い	9962	監査対象エンティティのID (optional)
from	日時	2018-07-01T08:00Z	開始日時
to	日時	2018-07-02T08:00Z	終了日時
fullText	糸	資産	全文検索フレーズ
skip	整数	0	ページング:指定されたアイテムインデックスから開始します
take	整数	10	ページング:指定された数のアイテムを表示します
sort	糸	タイムスタンプ	ソート元のElasticsearchフィールド
order	糸	DESC	並べ替え順序: ascまたは desc

{
 "items": [
   ... documents ...
 ],
 "total_items": 15,
 "returned_items": 10,
 "next": {
   "href": "<link to next page>",
   "title": ...
 },
 "previous": {
   "href": "<link to previous page>",
   "title": ...
 },
 "self": {
   "href": "<link to current page>",
   "title": ...
 }
}

一部のエンドポイントには、追加のパラメーターセットがあります。対応するセクションでは、相違点を指定します。

手記

アスタリスク (*) は、URLが値のリストを持つキーではなく、キーと値のペアのリストに展開されることを示します。たとえば、Uri.expand("{?userIds*}", {userIds:1,2}) は ?userIds=1,2ではなく ?userIds=1&userIds=2に展開されます。

スクロール

Elasticsearch(ES)クエリで許可されているよりも多くのアイテムをフェッチする必要がある場合は、スクロールAPIを使用する必要があります。これは一方向にのみページングを許可し、エンティティのスクロールエンドポイントと同様に機能します。

エンドポイントのベースアドレステンプレートは次のとおりです。

GET /api/audit/<INDEX_NAME>/scroll{/entityId}{?scrollTime,scrollId,from,to,fullText,skip,take,sort,order}

各スクロールエンドポイントは、対応するクエリエンドポイントと同じパラメーターセットを受け入れます。

スクロールエンドポイントは、次のパラメータをサポートしています。

名前	種類	サンプル値	形容
scrollId	糸	DXF1..U1QQ==	ESによって割り当てられたスクロールID。このパラメータは、レスポンスペイロードのnextリンクに自動的に追加されます。
scrollTime	タイムスパン	生	作成されたスクロールがESで存続する時間を決定します。指定しない場合、値は中央集権的な設定のreportingセクション (デフォルトは5000ms) から取得されます。

生成する

ログ全体またはそのサブセットのダウンロード注文を行うには、生成エンドポイントを使用します。

エンドポイントのベースアドレステンプレートは次のとおりです。

POST /api/audit/<INDEX_NAME>/generate

生成エンドポイントは、次のパラメーターをサポートします。

名前	種類	サンプル値	形容
audit_type	糸	生	次のいずれかの値: raw、business、scripting、action、または trigger
format	糸	CSVファイル	次のいずれかの値: csv, json
from	日時	2018-07-01T08:00Z	開始日時
to	日時	2018-07-02T08:00Z	終了日時
filter	辞書	{ "user_id": "6" }	選択した監査インデックスに適用された一連のフィルター

レスポンスヘッダー:

Location: <url to download order>

未加工クエリ

未加工のクエリには、/api/audit/raw/ と /api/audit/raw/operational/の2つのエンドポイントがあります。

未加工のクエリは、プロパティや関係の変更などのエンティティを含む未加工の監査インデックスをフェッチします ( M.Job、M.JobDescription、M.Target、M.Agent、M.AgentActivityを除く)。

エンドポイントのベースアドレステンプレートは次のとおりです。

GET /api/audit/raw/query{/entityId}{?eventTypes*,definitionNames*,userIds*,properties*,relations*,culture,from,to,fullText,skip,take,sort,order}

未加工のクエリエンドポイントは、次のパラメータをサポートしています。

名前	種類	サンプル値	形容
eventTypes	糸	エンティティ更新	監査対象のイベントの種類
definitionNames	糸	M.アセット	エンティティ定義名
userIds	長い	1211	ユーザーID
properties	糸	タイトル	提供されたプロパティに対して行われた変更によるフィルタリング
relations	糸	アセットからアセットメディア	指定されたリレーションに対して行われた変更によるフィルタリング
culture	糸	en-US	レスポンスデータの文化

GET /api/audit/raw/query?eventTypes=EntityUpdated

{
 "items": [
     {
       "event_type": "EntityUpdated",
       "message_id": 56272,
       "username": "SampleUser",
       "data": {
         "name": "User:6",
         "definition": "User",
         "version": 24,
         "cultures": [
           "invariant"
         ],
         "is_new": null,
         "user_id": null,
         "usergroup_id": null,
         "rules": null,
         "property_changes": [
           {
             "property": "LastLoginDateTime",
             "data_type": "System.DateTimeOffset",
             "value": {
               "original": "2021-04-19T09:26:43.3713536Z",
               "new": "2021-04-19T09:34:32.018373Z"
             }
           }
         ],
         "relation_changes": []
       },
       "audit_type": "Raw",
       "target_definition": "User",
       "target_id": 6,
       "timestamp": "2021-04-19T09:34:32.053Z",
       "user_id": 6
     },
     ...]
}

このエンドポイントは、M.Job、M.Target、M.JobDescription、M.Agent、M.AgentActivityエンティティのエンティティ更新を含む運用イベント専用で、/api/audit/raw/と同じパラメータを持ちます。

GET /api/audit/raw/operational/query?skip=0&take=25&sort=%40timestamp&order=desc

{
    "items": [
        {
            "event_type": "EntityUpdated",
            "message_id": 58271,
            "username": "Administrator",
            "data": {
                "name": "M.AgentActivity:34331",
                "definition": "M.AgentActivity",
                "version": 5,
                "cultures": [
                    "invariant"
                ],
                "is_new": null,
                "user_id": null,
                "usergroup_id": null,
                "rules": null,
                "property_changes": [
                    {
                        "property": "FlowLastUpdatedOn",
                        "data_type": "System.DateTime",
                        "value": {
                            "original": "2024-06-06T18:18:21.800809Z",
                            "new": "2024-06-06T18:18:28.0402161Z"
                        }
                    },
                    {
                        "property": "FlowLastUpdatedBy",
                        "data_type": "System.String",
                        "value": {
                            "original": "FlowUpdated",
                            "new": "AgentHeartbeat"
                        }
                    }
                ],
                "relation_changes": []
            },
            "id": "73df2336-4779-4c60-b2d6-ac249e7efa6e",
            "audit_type": "Raw",
            "target_definition": "M.AgentActivity",
            "target_id": 34331,
            "timestamp": "2024-06-06T18:18:28.333Z",
            "user_id": 6
        }
      ...
    ],
    "total_items": 5391,
    "returned_items": 1,
    "next": {
        "href": "https://localhost:8180/api/audit/raw/operational/query?skip=1&take=1&sort=@timestamp&order=Desc",
        "title": "The next page in this collection"
    },
    "self": {
        "href": "https://localhost:8180/api/audit/raw/operational/query?skip=0&take=1&sort=@timestamp&order=Desc",
        "title": "This collection"
    }
}

ビジネスクエリ

ビジネス・クエリーは、ビジネス監査インデックスをフェッチします。

エンドポイントのベースアドレステンプレートは次のとおりです。

GET /api/audit/business/query{/entityId}{?logType*,raw,from,to,fullText,skip,take,sort,order}

ビジネスクエリエンドポイントは、次のパラメータをサポートします。

名前	種類	サンプル値	形容
logType	糸	ユーザー監査	指定されたタイプによるフィルタリング
eventTypes	糸	user.login.success(ログイン成功)	イベントの種類。取り得る値: Created、Updated、Deleted、Enabled、Disabled、またはExecuted。
createdBy	糸	サンプルユーザー	ビジネスエンティティを作成したユーザー
modifiesBy	糸	サンプルユーザー	ビジネスエンティティを最後に変更したユーザー
username	糸	サンプルユーザー	クエリを行うユーザー
definition	糸		事業体の定義
raw	糸		生のElasticsearchクエリ(deprecated:互換性のために残されたパラメータ)

GET /api/audit/business/query?logType*==useraudit

{
"items": [
  {
    "event_type": "user.login.success",
    "created_by": "SampleUser",
    "modified_by": "SampleUser",
    "created_on": "2018-11-29T13:36:11.7964771Z",
    "modified_on": "2021-04-19T09:45:25.1231815Z",
    "username": "SampleUser",
    "log_type": "useraudit",
    "browser_information": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/90.0.4430.72 Safari/537.36",
    "geoip": {
      "continent_name": "Europe",
      "region_iso_code": "BE-VBR",
      "city_name": "Halle",
      "country_iso_code": "BE",
      "region_name": "Flemish Brabant Province",
      "location": {
        "lon": 4.2345,
        "lat": 50.7338
      }
     }
    },
    ...]
}

ビジネスジェネレーション

ビジネス生成エンドポイントは、次のパラメーターをサポートします。

名前	種類	サンプル値	形容
log_type	糸	ユーザー監査	filterプロパティをオーバーライドして、指定されたログの種類をフィルターとして設定します。

スクリプティングクエリ

スクリプトクエリは、スクリプト監査インデックスをフェッチしました。

エンドポイントのベースアドレステンプレートは次のとおりです。

GET /api/audit/scripting/query{/entityId}{?scriptType,scriptName,scriptContentId,scriptContentIdentifier,errorMessage,executionSource,id,eventType,severity,targetId,targetIdentifier,userId,from,to,fullText,skip,take,sort,order}

スクリプトクエリエンドポイントは、次のパラメータをサポートしています。

名前	種類	サンプル値	形容
scriptType	糸	ユーザー事前登録	スクリプトのタイプ。取り得る値: UserPreRegistration、UserPostRegistration、UserSignIn、MetadataProcessing、またはActionScript。
scriptName	糸	fooスクリプト	スクリプト名
scriptContentId	長い	1234	スクリプトコンテンツエンティティのID
scriptContentIdentifier	糸	zfSGGTUNhkKVdY9U-z49iQ	スクリプトコンテンツエンティティの識別子
errorMessage	糸	失敗しました	エラーメッセージのフラグメント
executionSource	糸	自動	スクリプト実行ソース。取り得る値: Automatic、Trigger、WebApi、Command、ExternalAction、またはMassEdit。
id	グイド	0CCD58CF-C83F-42BA-907F-44D8950A20FD	監査メッセージID
eventType	糸	作成	イベントの種類。取り得る値: Created、Updated、Deleted、Enabled、Disabled、またはExecuted。
severity	糸	警告	監査エントリの重大度。取り得る値: Debug、Warning、Info、Error、またはFatal。
targetId	長い	1234	監査対象エンティティのID
targetIdentifier	糸	zfSGGTUNhkKVdY9U-z49iQ	監査対象エンティティの識別子
userId	長い	1234	監査エントリの作成をトリガーしたユーザーのID

GET /api/audit/scripting/query?scriptType==UserPreRegistration

{
 "items": [
    {
      "script_type": "ActionScript",
      "script_name": "CMP - Create public links for linked assets",
      "script_content_id": 30459,
      "script_content_identifier": "gqQwt42TR0-H053IJPX5KQ",
      "execution_time": 2343,
      "execution_source": "Trigger",
      "context_data": {
        "data": {},
        "execution_event": null,
        "execution_phase": null,
        "execution_source": "Trigger",
        "execution_type": "OutOfProcess",
        "result": {},
        "target": "Asset",
        "target_id": 31523,
        "target_type": null
       }
      },

      ...]
     }
    }

アクションクエリ

アクション問合せは、アクション監査インデックスをフェッチします。

エンドポイントのベースアドレステンプレートは次のとおりです。

GET /api/audit/action/query{/entityId}{?actionType,actionPhase,executionType,executionSource,executionTime,messageId,retryCount,success,id,eventType,severity,targetId,targetIdentifier,userId,from,to,fullText,skip,take,sort,order}

アクションクエリエンドポイントは、次のパラメータをサポートします。

名前	種類	サンプル値	形容
actionType	糸	アピコール	アクションの種類。取り得る値: ApiCall、ActionScript、AzureEventHub、ReportingChannel、PrintEntityGeneration、StartBpmAutomation、StartSmAutomation、AzureServiceBus、またはMAzureServiceBus。
actionPhase	糸	前	アクションが実行されるフェーズ。可能な値: Post、Pre、Security、Validation、Audit。
executionType	糸	インプロセス	実行のタイプ。可能な値: OutOfProcessまたはInProcess。
executionSource	糸	トリガー	実行のソース。取り得る値: Unknown、Trigger、ExternalAction、Command、WebApi、MassEdit、またはBPM。
executionTime	長い	234	経過した実行時間 (ミリ秒)
messageId	長い	1234	メッセージID
retryCount	整数	3	再試行回数
success	ブール	真	アクションが成功したかどうか
id	グイド	0CCD58CF-C83F-42BA-907F-44D8950A20FD	監査メッセージID
eventType	糸	作成	イベントの種類。取り得る値: Created、Updated、Deleted、Enabled、Disabled、またはExecuted。
severity	糸	警告	監査エントリの重大度。取り得る値: Debug、Warning、Info、Error、またはFatal。
targetId	長い	1234	監査対象エンティティのID
targetIdentifier	糸	zfSGGTUNhkKVdY9U-z49iQ	監査対象エンティティの識別子
userId	長い	1234	監査エントリの作成をトリガーしたユーザーのID

GET /api/audit/action/query?actiontype==ApiCall

{
  "items": [
    {
      "action_type": "StartSmAutomation",
      "action_phase": "Post",
      "execution_type": "InProcess",
      "execution_source": "Trigger",
      "execution_time": 8,
      "target_name": "CMP - Content approval action",
      "retry_count": 0,
      "success": true,
      "entity_id": 33232,
      "id": "42e0ca85-87d1-437b-9df8-3decbadd1bf8",
      "audit_type": "Action",
      "event_type": "Executed",
      "severity": "Info",
      "target_id": 9878,
      "target_identifier": "M.Action.CMP.Content.Approval",
      "timestamp": "2021-04-19T10:42:09.8503118Z",
      "user_id": 6
    },
    ...]
   }

この記事を改善するための提案がある場合は、お知らせください!

エンドポイントの監査

クエリ

スクロール

生成する

未加工クエリ

ビジネスクエリ

ビジネスジェネレーション

スクリプティングクエリ

アクション クエリ

アクションクエリ