セキュリティログ
securityLogリソースを使用して、セキュリティログエントリを受信します。セキュリティログには、ログインアクションやユーザー、ユーザーグループ、およびロールの作成、更新、削除などのイベントに関する情報が含まれます。このリソースを使用するには、管理者ロールでログインする必要があります。
GET要求
過去24時間のエントリを最大200エントリ要求するには、次のURIを使用します。
/public/core/v3/securityLog
または、クエリパラメータを使用して、返されるエントリを指定できます。例えば、次のURIは2019年7月26日の午前8:00から午後5:00までの間に作成されたエントリを返します。
/public/core/v3/securityLog?q=entryTime>="2019-07-26T08:00:00.000Z";entryTime<="2019-07-26T17:00:00.000Z"
URIで以下のクエリパラメータを含めることができます。
パラメータ | タイプ | 説明 |
---|
entryTime | 文字列 | エントリの開始時刻または終了時刻(UTC形式)。 次のいずれかの形式を使用します。 - - yyyy-MM-dd'T'HH:mm:ss'Z'
- - yyyy-MM-dd'T'HH:mm:ssZ
- - yyyy-MM-dd'T'HH:mm:ss.SSS'Z'
- - yyyy-MM-dd'T'HH:mm:ss.SSSZ
日付の最大範囲は14日間です。 以下の演算子を使用できます。 デフォルトでは、過去24時間のエントリを最大200個返します。 |
actionCategory | 文字列 | セキュリティログエントリのカテゴリ。 以下の演算子を使用できます。 このクエリパラメータを使用するには、entryTimeクエリパラメータを使用して有効な時刻範囲も含める必要があります。 |
actor | String | アクションを実行したユーザー名。 以下の演算子を使用できます。 このクエリパラメータを使用するには、entryTimeクエリパラメータを使用して有効な時刻範囲も含める必要があります。 |
objectName | String | 作用したオブジェクト名。 以下の演算子を使用できます。 このクエリパラメータを使用するには、entryTimeクエリパラメータを使用して有効な時刻範囲も含める必要があります。 |
skip | Int | スキップするレコード数。 このクエリパラメータを使用するには、entryTimeクエリパラメータを使用して有効な時刻範囲も含める必要があります。 デフォルトは0です。 |
limit | Int | 応答に含まれるエントリの数。 指定できる最小は100、最大は1000です。 デフォルトは200です。 |
GET応答
返される各セキュリティログエントリでsecurityLogEntryオブジェクトを返します。エラーが発生した場合にエラーオブジェクトを返します。
securityLogEntryオブジェクトには次の属性が含まれます。
フィールド | タイプ | 説明 |
---|
id | String | セキュリティログのエントリID。 |
orgId | String | 組織ID |
actor | String | アクションを実行したユーザー。 |
entryTime | タイムスタンプ | アクションが発生した時刻。 |
objectId | String | 使用されたオブジェクトのID。 |
objectName | String | 使用されたオブジェクト名。 |
actionCategory | String | セキュリティログエントリのカテゴリ。次のいずれかのコードを返します。 - - 認証
- - 組織
- - サブ組織。
- - ユーザー
- - グループ
- - ロール
- - 特権
- - エージェント
- - 特権カテゴリ
- - 設定
|
actionEvent | String | 実行されるアクションのタイプ。次のいずれかのコードを返します。 - - CREATE
- - UPDATE
- - DELETE
- - DISABLE
- - AGENT_LOGIN
- - USER_LOGIN
- - LOGOUT
- - PASSWORD_RESET
|
GETの例
ユーザー「admin」が2019年7月26日の午前8:00から午後5:00までの間に実行したアクションのエントリを表示する場合、次のURIを使用できます。
GET <baseApiUrl>/public/core/v3/securityLog?q=entryTime>="2019-07-26T08:00:00.000Z";entryTime<="2019-07-26T17:00:00.000Z";actor=='admin'
Content-Type: application/json
Accept: application/json
INFA-SESSION-ID: <sessionId>
応答は以下の例のようになります。
{
"entries": [
{
"id": "1AoqT9lYsrUhu7kl49kGsx",
"orgId": "9l10ywsSnqadMx1NtEEbKT",
"actor": "admin",
"entryTime": "2019-07-23T22:28:07.000Z",
"objectId": "9l10ywsSnqadMx1NtEEbKT",
"objectName": "idsv3_org_1563920884151",
"actionCategory": "Organization",
"actionEvent": "CREATE"
},
{
"id": "595EZai5YqFi6X8GIpVVu0",
"orgId": "9l10ywsSnqadMx1NtEEbKT",
"actor": "admin",
"entryTime": "2019-07-23T22:28:13.000Z",
"objectId": "9pieratUfEWkhFHnzY1r49",
"objectName": "idsv3_user_1563920884151",
"actionCategory": "User",
"actionEvent": "CREATE"
}
]
}