メインコンテンツまでスキップ
API docs by Redocly

idp-server コントロールプレーン セキュリティイベント管理 API (1.0.0)

Download OpenAPI specification:Download

セキュリティイベント、監査ログ、セキュリティイベントフックの管理API仕様書

organization-security-event

組織レベルセキュリティイベント管理

List organization security events

組織テナント内のセキュリティイベント一覧を取得します

path Parameters
organization-id
required
string <uuid>

組織の識別子

tenant-id
required
string

テナントの識別子

query Parameters
limit
integer [ 1 .. 1000 ]
Default: 20

返すセキュリティイベントの最大数

offset
integer >= 0
Default: 0

ページネーションのためにスキップするセキュリティイベント数

event_type
string
Example: event_type=login_success,inspect_token_success

セキュリティイベントタイプでフィルター（カンマ区切りで複数指定可能）

from
string <date-time>

セキュリティイベントをフィルターするための開始タイムスタンプ（ISO 8601形式）

注意: デフォルト値は設定されていません。省略時は全期間から検索します。

to
string <date-time>

セキュリティイベントをフィルターするための終了タイムスタンプ（ISO 8601形式）

注意: デフォルト値は設定されていません。省略時は全期間から検索します。

client_id
string

クライアント識別子でフィルター

user_id
string <uuid>

ユーザー識別子でフィルター

external_user_id
string

外部ユーザー識別子でフィルター

user_name
string

ユーザー名でフィルター（部分一致）

ip_address
string
Example: ip_address=192.168.1.100

IPアドレスでフィルター（IPv4またはIPv6形式、完全一致）

user_agent
string
Example: user_agent=Mozilla

User-Agentでフィルター（部分一致）

Responses

Response samples

Content type
application/json
{
  • "list": [
    ],
  • "total_count": 0,
  • "limit": 0,
  • "offset": 0
}

Get organization security event details

組織テナント内の特定のセキュリティイベントの詳細情報を取得します

path Parameters
organization-id
required
string <uuid>

組織の識別子

tenant-id
required
string

テナントの識別子

event-id
required
string <uuid>

セキュリティイベント識別子

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "type": "string",
  • "description": "string",
  • "tenant": {},
  • "client": {
    },
  • "user": {
    },
  • "detail": { },
  • "created_at": "2019-08-24T14:15:22Z"
}

organization-audit-log

組織レベル監査ログ管理

List organization audit logs

組織レベルでの監査ログ一覧を取得します。指定された組織とテナントに関連する監査ログを検索条件に基づいて取得できます。

動的属性フィルタ: attributes.* パラメータを使用して監査ログの属性による絞り込みが可能です。 例：attributes.resource_type=user, attributes.operation=create

path Parameters
organization-id
required
string <uuid>

組織の識別子

tenant-id
required
string

テナントの識別子

query Parameters
limit
integer [ 1 .. 1000 ]
Default: 20

取得する監査ログの最大件数（1-1000）

offset
integer >= 0
Default: 0

ページネーション用のオフセット（スキップする監査ログ数）

from
string <date-time>

監査ログ検索の開始日時（ISO 8601形式）

注意: デフォルト値は設定されていません。省略時は全期間から検索します。

to
string <date-time>

監査ログ検索の終了日時（ISO 8601形式）

注意: デフォルト値は設定されていません。省略時は全期間から検索します。

type
string

監査ログタイプによるフィルタ

複数指定: カンマ区切りで複数のタイプを同時検索可能 例: tenant_create,tenant_update,tenant_delete

description
string

説明テキストによるフィルタ

target_resource
string

対象リソースによるフィルタ

target_action
string

対象アクションによるフィルタ

outcome_result
string
Enum: "success" "failure"

操作結果によるフィルタ

用途: 成功/失敗した操作のみを検索 値: success または failure

target_tenant_id
string

対象テナントIDによるフィルタ

用途: 特定のテナントに対する操作のみを検索（テナント管理操作など）

dry_run
boolean

ドライラン実行フィルタ

用途: 本番実行とドライラン実行を区別して検索 値: true - ドライラン実行のみ, false - 本番実行のみ

client_id
string

クライアント識別子によるフィルタ

user_id
string <uuid>

内部ユーザIDによるフィルタ

external_user_id
string

外部ユーザ識別子によるフィルタ

Responses

Response samples

Content type
application/json
{
  • "list": [
    ],
  • "total_count": 0,
  • "limit": 0,
  • "offset": 0
}

Get organization audit log details

組織レベルでの特定の監査ログの詳細情報を取得します。

path Parameters
organization-id
required
string <uuid>

組織の識別子

tenant-id
required
string

テナントの識別子

log-id
required
string <uuid>

監査ログの識別子

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "type": "string",
  • "description": "string",
  • "tenant_id": "34f5c98e-f430-457b-a812-92637d0c6fd0",
  • "client_id": "string",
  • "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
  • "external_user_id": "string",
  • "user_payload": { },
  • "target_resource": "string",
  • "target_resource_action": "string",
  • "ip_address": "string",
  • "user_agent": "string",
  • "before": { },
  • "after": { },
  • "attributes": { },
  • "dry_run": false,
  • "created_at": "2019-08-24T14:15:22Z"
}

organization-security-event-hook

組織レベルセキュリティイベントフック設定管理

Create security event hook configuration

組織内のテナントに対して新しいセキュリティイベントフック設定を作成します

path Parameters
organization-id
required
string <uuid>

組織の識別子

tenant-id
required
string

テナントの識別子

query Parameters
dry_run
boolean
Default: false

trueの場合、リクエストの検証のみで実行はされません

Request Body schema: application/json
required
id
string <uuid>

セキュリティイベントフック設定の一意識別子（指定しない場合は自動生成）

type
required
string (StandardSecurityEventHookType)
Enum: "WEBHOOK" "SSF" "Email"

標準セキュリティイベントフックタイプ:

  • WEBHOOK: HTTP Webフック通知
  • SSF: Security Event Token (SET) 形式通知
  • Email: メール通知
object

フックタイプ固有の属性（WebフックURL、メールアドレス等）

object

フック設定に関連付けられたカスタムメタデータ

triggers
Array of strings

フック実行のカスタムトリガー条件

execution_order
integer >= 0
Default: 0

他のフックに対するこのフックの実行順序

required
object

イベントタイプをキーとするイベント毎の実行設定

enabled
required
boolean
Default: true

このフック設定が有効かどうか

store_execution_payload
boolean
Default: false

監査目的で実行ペイロードを保存するかどうか

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "type": "WEBHOOK",
  • "attributes": { },
  • "metadata": { },
  • "triggers": [
    ],
  • "execution_order": 0,
  • "events": {
    },
  • "enabled": true,
  • "store_execution_payload": false
}

Response samples

Content type
application/json
{
  • "dry_run": true,
  • "result": {
    }
}

List security event hook configurations

組織内のテナントの全セキュリティイベントフック設定を取得します

path Parameters
organization-id
required
string <uuid>

組織の識別子

tenant-id
required
string

テナントの識別子

query Parameters
limit
integer [ 1 .. 1000 ]
Default: 20

返すアイテムの最大数

offset
integer >= 0
Default: 0

アイテムを返す開始インデックス

enabled
boolean

有効ステータスでフィルタリング

type
string (StandardSecurityEventHookType)
Enum: "WEBHOOK" "SSF" "Email"

フックタイプでフィルタリング (WEBHOOK, SSF, Email)

Responses

Response samples

Content type
application/json
{
  • "list": [
    ],
  • "total_count": 0,
  • "limit": 0,
  • "offset": 0
}

Get specific security event hook configuration

IDで特定のセキュリティイベントフック設定を取得します

path Parameters
organization-id
required
string <uuid>

組織の識別子

tenant-id
required
string

テナントの識別子

config-id
required
string <uuid>

セキュリティイベントフック設定ID

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "type": "WEBHOOK",
  • "attributes": { },
  • "metadata": { },
  • "triggers": [
    ],
  • "execution_order": 0,
  • "events": {
    },
  • "enabled": true,
  • "store_execution_payload": true,
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

Update security event hook configuration

既存のセキュリティイベントフック設定を更新します

path Parameters
organization-id
required
string <uuid>

組織の識別子

tenant-id
required
string

テナントの識別子

config-id
required
string <uuid>

セキュリティイベントフック設定ID

query Parameters
dry_run
boolean
Default: false

trueの場合、リクエストの検証のみで実行はされません

Request Body schema: application/json
required
id
string <uuid>

セキュリティイベントフック設定の一意識別子（指定しない場合は自動生成）

type
required
string (StandardSecurityEventHookType)
Enum: "WEBHOOK" "SSF" "Email"

標準セキュリティイベントフックタイプ:

  • WEBHOOK: HTTP Webフック通知
  • SSF: Security Event Token (SET) 形式通知
  • Email: メール通知
object

フックタイプ固有の属性（WebフックURL、メールアドレス等）

object

フック設定に関連付けられたカスタムメタデータ

triggers
Array of strings

フック実行のカスタムトリガー条件

execution_order
integer >= 0
Default: 0

他のフックに対するこのフックの実行順序

required
object

イベントタイプをキーとするイベント毎の実行設定

enabled
required
boolean
Default: true

このフック設定が有効かどうか

store_execution_payload
boolean
Default: false

監査目的で実行ペイロードを保存するかどうか

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "type": "WEBHOOK",
  • "attributes": { },
  • "metadata": { },
  • "triggers": [
    ],
  • "execution_order": 0,
  • "events": {
    },
  • "enabled": true,
  • "store_execution_payload": false
}

Response samples

Content type
application/json
{
  • "dry_run": true,
  • "result": {
    }
}

Delete security event hook configuration

既存のセキュリティイベントフック設定を削除します

path Parameters
organization-id
required
string <uuid>

組織の識別子

tenant-id
required
string

テナントの識別子

config-id
required
string <uuid>

セキュリティイベントフック設定ID

query Parameters
dry_run
boolean
Default: false

trueの場合、リクエストの検証のみで実行はされません

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "config_id": "d1d31429-d888-4f1c-b9c1-4e842f9bce5b",
  • "dry_run": true
}

List security event hook execution results

組織内のテナントのセキュリティイベントフック実行結果一覧を取得します

path Parameters
organization-id
required
string <uuid>

組織の識別子

tenant-id
required
string

テナントの識別子

query Parameters
limit
integer [ 1 .. 1000 ]
Default: 20

返却する結果の最大数（1-1000）

offset
integer >= 0
Default: 0

アイテムを返す開始インデックス

from
string <date-time>

検索開始日時（ISO 8601形式） 未指定の場合は時間範囲制限なし

to
string <date-time>

検索終了日時（ISO 8601形式） 未指定の場合は時間範囲制限なし

id
string <uuid>

フック実行結果IDでフィルタリング

security_event_id
string <uuid>

セキュリティイベントIDでフィルタリング

event_type
string
Example: event_type=user_created,user_updated

イベントタイプでフィルタリング

単一値: event_type=user_created 複数値: event_type=user_created,user_updated,user_deleted（カンマ区切り）

hook_type
string

フックタイプでフィルタリング（WEBHOOK, SSF, Email）

status
string
Enum: "SUCCESS" "FAILURE" "RETRY_SUCCESS" "RETRY_FAILURE"

実行ステータスでフィルタリング

user_id
string <uuid>

ユーザーID（sub）で完全一致フィルタリング

user_name
string

ユーザー名で部分一致フィルタリング

external_user_id
string

外部ユーザーID（ex_sub）で完全一致フィルタリング

Responses

Response samples

Content type
application/json
{
  • "list": [
    ],
  • "total_count": 0,
  • "limit": 0,
  • "offset": 0
}

Get security event hook execution result details

特定のセキュリティイベントフック実行結果の詳細を取得します

path Parameters
organization-id
required
string <uuid>

組織の識別子

tenant-id
required
string

テナントの識別子

hook-result-id
required
string <uuid>

フック実行結果ID

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "status": "SUCCESS",
  • "type": "string",
  • "security_event": {
    },
  • "contents": { },
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

Retry failed security event hook execution

失敗したセキュリティイベントフック実行を再試行します。元のセキュリティイベントと最新のフック設定を使用して再実行します。

path Parameters
organization-id
required
string <uuid>

組織の識別子

tenant-id
required
string

テナントの識別子

hook-result-id
required
string <uuid>

再試行するフック実行結果ID

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "status": "SUCCESS",
  • "type": "string",
  • "security_event": {
    },
  • "contents": { },
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}