Skip to content

署名付き埋め込み

署名付き埋め込みは、公開時点のノートブックの内容を外部サイトやアプリに埋め込む機能です。 認証には APIキー を利用します。

イベント一覧

イベントリソース説明
signed_embed.publishsigned_embed署名付き埋め込みが公開された
signed_embed.publish_changessigned_embed署名付き埋め込みの変更が公開された
signed_embed.renamesigned_embed署名付き埋め込みの名前が変更された
signed_embed.update_allowed_originssigned_embed署名付き埋め込みの許可オリジンが更新された
signed_embed.upsert_paramsigned_embed_param署名付き埋め込みのサーバーサイドパラメータが追加または更新された
signed_embed.remove_paramsigned_embed_param署名付き埋め込みのサーバーサイドパラメータが削除された
signed_embed.opensigned_embed署名付き埋め込みが開かれた
signed_embed.add_api_keysigned_embed署名付き埋め込みに許可 APIキーが追加された
signed_embed.remove_api_keysigned_embed署名付き埋め込みから許可 APIキーが削除された
signed_embed.issue_tokensigned_embed署名付き埋め込みのトークンが発行された
signed_embed.deletesigned_embed署名付き埋め込みが削除された

イベント詳細

signed_embed.publish プレビュー

記録期間: 2026-09-15 〜

署名付き埋め込みの公開を記録します。

フィールド
event.codesigned_embed.publish
scope.typeworkspace
resource.typesigned_embed
references(なし)
query(なし)
outbound(なし)
change(なし)
grant(なし)
extra(なし)

サンプル

json
{
  "event": {
    "code": "signed_embed.publish",
    ...
  },
  "scope": {
    "type": "workspace",
    ...
  },
  "resource": {
    "type": "signed_embed",
    "uid": "63e1be654aa70ad689601bf7",
    "name": "Partner Embed",
    "path": "notebook/63e1be654aa70ad689601bf3/signed_embed/63e1be654aa70ad689601bf7",
    "parts": [
      {
        "type": "notebook",
        "uid": "63e1be654aa70ad689601bf3",
        "name": "Sales KPI"
      },
      {
        "type": "signed_embed",
        "uid": "63e1be654aa70ad689601bf7",
        "name": "Partner Embed"
      }
    ],
    ...
  },
  ...
}

signed_embed.publish_changes プレビュー

記録期間: 2026-09-15 〜

署名付き埋め込みの変更内容の公開を記録します。

フィールド
event.codesigned_embed.publish_changes
scope.typeworkspace
resource.typesigned_embed
references(なし)
query(なし)
outbound(なし)
change(なし)
grant(なし)
extra(なし)

サンプル

json
{
  "event": {
    "code": "signed_embed.publish_changes",
    ...
  },
  "scope": {
    "type": "workspace",
    ...
  },
  "resource": {
    "type": "signed_embed",
    "uid": "63e1be654aa70ad689601bf7",
    "name": "Partner Embed",
    "path": "notebook/63e1be654aa70ad689601bf3/signed_embed/63e1be654aa70ad689601bf7",
    "parts": [
      {
        "type": "notebook",
        "uid": "63e1be654aa70ad689601bf3",
        "name": "Sales KPI"
      },
      {
        "type": "signed_embed",
        "uid": "63e1be654aa70ad689601bf7",
        "name": "Partner Embed"
      }
    ],
    ...
  },
  ...
}

signed_embed.rename プレビュー

記録期間: 2026-09-15 〜

署名付き埋め込みの表示名の変更を記録します。

フィールド
event.codesigned_embed.rename
scope.typeworkspace
resource.typesigned_embed
references(なし)
query(なし)
outbound(なし)
changename
grant(なし)
extra(なし)

change

名前モード必須説明
namestring必須変更前後の表示名
sensitivity: pii

サンプル

json
{
  "event": {
    "code": "signed_embed.rename",
    ...
  },
  "scope": {
    "type": "workspace",
    ...
  },
  "resource": {
    "type": "signed_embed",
    "uid": "63e1be654aa70ad689601bf7",
    "name": "Partner Embed",
    "path": "notebook/63e1be654aa70ad689601bf3/signed_embed/63e1be654aa70ad689601bf7",
    "parts": [
      {
        "type": "notebook",
        "uid": "63e1be654aa70ad689601bf3",
        "name": "Sales KPI"
      },
      {
        "type": "signed_embed",
        "uid": "63e1be654aa70ad689601bf7",
        "name": "Partner Embed"
      }
    ],
    ...
  },
  "change": {
    "fields": [
      {
        "name": "name",
        "old": "Old",
        "new": "Partner Embed"
      }
    ]
  },
  ...
}

signed_embed.update_allowed_origins プレビュー

記録期間: 2026-09-15 〜

署名付き埋め込みの許可オリジンの更新を記録します。

フィールド
event.codesigned_embed.update_allowed_origins
scope.typeworkspace
resource.typesigned_embed
references(なし)
query(なし)
outbound(なし)
changeallowed_origins
grant(なし)
extra(なし)

change

名前モード必須説明
allowed_origins集合string[]任意追加・削除されたオリジン。増減がなかった側は空配列になります。

サンプル

json
{
  "event": {
    "code": "signed_embed.update_allowed_origins",
    ...
  },
  "scope": {
    "type": "workspace",
    ...
  },
  "resource": {
    "type": "signed_embed",
    "uid": "63e1be654aa70ad689601bf7",
    "name": "Partner Embed",
    "path": "notebook/63e1be654aa70ad689601bf3/signed_embed/63e1be654aa70ad689601bf7",
    "parts": [
      {
        "type": "notebook",
        "uid": "63e1be654aa70ad689601bf3",
        "name": "Sales KPI"
      },
      {
        "type": "signed_embed",
        "uid": "63e1be654aa70ad689601bf7",
        "name": "Partner Embed"
      }
    ],
    ...
  },
  "change": {
    "fields": [
      {
        "name": "allowed_origins",
        "added": [
          "https://partner.example.com"
        ],
        "removed": []
      }
    ]
  },
  ...
}

signed_embed.upsert_param プレビュー

記録期間: 2026-09-15 〜

署名付き埋め込みのサーバーサイドパラメータの追加または更新を記録します。

フィールド
event.codesigned_embed.upsert_param
scope.typeworkspace
resource.typesigned_embed_param
references(なし)
query(なし)
outbound(なし)
change上書き方法
grant(なし)
extra(なし)

change

パラメータの値は記録しません。overwrite_type の変更のみが入ります。

名前モード必須説明
overwrite_typeSignedEmbedParamOverwriteType必須パラメータの上書き方法。新規作成時は new のみ、変更時は oldnew

サンプル

固定値で上書きする
json
{
  "event": {
    "code": "signed_embed.upsert_param",
    ...
  },
  "scope": {
    "type": "workspace",
    ...
  },
  "resource": {
    "type": "signed_embed_param",
    "uid": "wgt_1",
    "name": null,
    "path": "notebook/63e1be654aa70ad689601bf3/signed_embed/63e1be654aa70ad689601bf7/signed_embed_param/wgt_1",
    "parts": [
      {
        "type": "notebook",
        "uid": "63e1be654aa70ad689601bf3",
        "name": "Sales KPI"
      },
      {
        "type": "signed_embed",
        "uid": "63e1be654aa70ad689601bf7",
        "name": "Partner Embed"
      },
      {
        "type": "signed_embed_param",
        "uid": "wgt_1",
        "name": null
      }
    ],
    ...
  },
  "change": {
    "fields": [
      {
        "name": "overwrite_type",
        "new": "FIXED"
      }
    ]
  },
  ...
}
初期値を設定する
json
{
  "event": {
    "code": "signed_embed.upsert_param",
    ...
  },
  "scope": {
    "type": "workspace",
    ...
  },
  "resource": {
    "type": "signed_embed_param",
    "uid": "wgt_1",
    "name": null,
    "path": "notebook/63e1be654aa70ad689601bf3/signed_embed/63e1be654aa70ad689601bf7/signed_embed_param/wgt_1",
    "parts": [
      {
        "type": "notebook",
        "uid": "63e1be654aa70ad689601bf3",
        "name": "Sales KPI"
      },
      {
        "type": "signed_embed",
        "uid": "63e1be654aa70ad689601bf7",
        "name": "Partner Embed"
      },
      {
        "type": "signed_embed_param",
        "uid": "wgt_1",
        "name": null
      }
    ],
    ...
  },
  "change": {
    "fields": [
      {
        "name": "overwrite_type",
        "new": "DEFAULT"
      }
    ]
  },
  ...
}

signed_embed.remove_param プレビュー

記録期間: 2026-09-15 〜

署名付き埋め込みのサーバーサイドパラメータの削除を記録します。

フィールド
event.codesigned_embed.remove_param
scope.typeworkspace
resource.typesigned_embed_param
references(なし)
query(なし)
outbound(なし)
changeoverwrite_type
grant(なし)
extra(なし)

change

名前モード必須説明
overwrite_typeSignedEmbedParamOverwriteType任意削除時点の上書き方法。

サンプル

json
{
  "event": {
    "code": "signed_embed.remove_param",
    ...
  },
  "scope": {
    "type": "workspace",
    ...
  },
  "resource": {
    "type": "signed_embed_param",
    "uid": "wgt_1",
    "name": null,
    "path": "notebook/63e1be654aa70ad689601bf3/signed_embed/63e1be654aa70ad689601bf7/signed_embed_param/wgt_1",
    "parts": [
      {
        "type": "notebook",
        "uid": "63e1be654aa70ad689601bf3",
        "name": "Sales KPI"
      },
      {
        "type": "signed_embed",
        "uid": "63e1be654aa70ad689601bf7",
        "name": "Partner Embed"
      },
      {
        "type": "signed_embed_param",
        "uid": "wgt_1",
        "name": null
      }
    ],
    ...
  },
  "change": {
    "fields": [
      {
        "name": "overwrite_type",
        "old": "FIXED"
      }
    ]
  },
  ...
}

signed_embed.open プレビュー

記録期間: 2026-09-15 〜

署名付き埋め込みの表示を記録します。

フィールド
event.codesigned_embed.open
scope.typeworkspace
resource.typesigned_embed
references(なし)
query(なし)
outbound(なし)
change(なし)
grant(なし)
extra(なし)

サンプル

json
{
  "event": {
    "code": "signed_embed.open",
    ...
  },
  "scope": {
    "type": "workspace",
    ...
  },
  "resource": {
    "type": "signed_embed",
    "uid": "63e1be654aa70ad689601bf7",
    "name": "Partner Embed",
    "path": "notebook/63e1be654aa70ad689601bf3/signed_embed/63e1be654aa70ad689601bf7",
    "parts": [
      {
        "type": "notebook",
        "uid": "63e1be654aa70ad689601bf3",
        "name": "Sales KPI"
      },
      {
        "type": "signed_embed",
        "uid": "63e1be654aa70ad689601bf7",
        "name": "Partner Embed"
      }
    ],
    ...
  },
  "context": {
    "signed_embed": {
      "signed_embed": {
        "type": "signed_embed",
        "uid": "63e1be654aa70ad689601bf7",
        "name": "Partner Embed"
      },
      "notebook": {
        "type": "notebook",
        "uid": "63e1be654aa70ad689601bf3",
        "name": "Sales KPI"
      },
      "page": {
        "type": "notebook_page",
        "uid": "671ecbbf2990c63fea3b3a26",
        "name": "Overview"
      },
      "token_user_id": "user:1234567890",
      "params": [
        {
          "param_uid": "6722c7061b02448a4056d84d",
          "value": "\"Hello world\"",
          "overwrite_type": "FIXED"
        }
      ]
    }
  },
  ...
}

signed_embed.add_api_key プレビュー

記録期間: 2026-09-15 〜

署名付き埋め込みへの許可 APIキーの追加を記録します。

フィールド
event.codesigned_embed.add_api_key
scope.typeworkspace
resource.typesigned_embed
references許可 APIキー
query(なし)
outbound(なし)
change(なし)
grant(なし)
extra(なし)

references

許可した APIキーの識別子が入ります。

relationtype必須説明
targetapi_key必須APIキー

サンプル

json
{
  "event": {
    "code": "signed_embed.add_api_key",
    ...
  },
  "scope": {
    "type": "workspace",
    ...
  },
  "resource": {
    "type": "signed_embed",
    "uid": "63e1be654aa70ad689601bf7",
    "name": "Partner Embed",
    "path": "notebook/63e1be654aa70ad689601bf3/signed_embed/63e1be654aa70ad689601bf7",
    "parts": [
      {
        "type": "notebook",
        "uid": "63e1be654aa70ad689601bf3",
        "name": "Sales KPI"
      },
      {
        "type": "signed_embed",
        "uid": "63e1be654aa70ad689601bf7",
        "name": "Partner Embed"
      }
    ],
    ...
  },
  "references": [
    {
      "type": "api_key",
      "uid": "63e1be654aa70ad689601bee",
      "relation": "target"
    }
  ],
  ...
}

signed_embed.remove_api_key プレビュー

記録期間: 2026-09-15 〜

署名付き埋め込みからの許可 APIキーの削除を記録します。

フィールド
event.codesigned_embed.remove_api_key
scope.typeworkspace
resource.typesigned_embed
references許可 APIキー
query(なし)
outbound(なし)
change(なし)
grant(なし)
extra(なし)

references

許可を外した APIキーの識別子が入ります。

relationtype必須説明
targetapi_key必須APIキー

サンプル

json
{
  "event": {
    "code": "signed_embed.remove_api_key",
    ...
  },
  "scope": {
    "type": "workspace",
    ...
  },
  "resource": {
    "type": "signed_embed",
    "uid": "63e1be654aa70ad689601bf7",
    "name": "Partner Embed",
    "path": "notebook/63e1be654aa70ad689601bf3/signed_embed/63e1be654aa70ad689601bf7",
    "parts": [
      {
        "type": "notebook",
        "uid": "63e1be654aa70ad689601bf3",
        "name": "Sales KPI"
      },
      {
        "type": "signed_embed",
        "uid": "63e1be654aa70ad689601bf7",
        "name": "Partner Embed"
      }
    ],
    ...
  },
  "references": [
    {
      "type": "api_key",
      "uid": "63e1be654aa70ad689601bee",
      "relation": "target"
    }
  ],
  ...
}

signed_embed.issue_token プレビュー

記録期間: 2026-09-15 〜

署名付き埋め込みのトークンの発行を記録します。

フィールド
event.codesigned_embed.issue_token
scope.typeworkspace
resource.typesigned_embed
references(なし)
query(なし)
outbound(なし)
change(なし)
grant(なし)
extra(なし)

サンプル

json
{
  "event": {
    "code": "signed_embed.issue_token",
    ...
  },
  "scope": {
    "type": "workspace",
    ...
  },
  "resource": {
    "type": "signed_embed",
    "uid": "63e1be654aa70ad689601bf7",
    "name": "Partner Embed",
    "path": "notebook/63e1be654aa70ad689601bf3/signed_embed/63e1be654aa70ad689601bf7",
    "parts": [
      {
        "type": "notebook",
        "uid": "63e1be654aa70ad689601bf3",
        "name": "Sales KPI"
      },
      {
        "type": "signed_embed",
        "uid": "63e1be654aa70ad689601bf7",
        "name": "Partner Embed"
      }
    ],
    ...
  },
  "context": {
    "signed_embed": {
      "signed_embed": {
        "type": "signed_embed",
        "uid": "63e1be654aa70ad689601bf7",
        "name": "Partner Embed"
      },
      "notebook": {
        "type": "notebook",
        "uid": "63e1be654aa70ad689601bf3",
        "name": "Sales KPI"
      },
      "page": {
        "type": "notebook_page",
        "uid": "671ecbbf2990c63fea3b3a26",
        "name": "Overview"
      },
      "token_user_id": "user:1234567890",
      "params": [
        {
          "param_uid": "6722c7061b02448a4056d84d",
          "value": "\"Hello world\"",
          "overwrite_type": "FIXED"
        }
      ]
    }
  },
  ...
}

signed_embed.delete プレビュー

記録期間: 2026-09-15 〜

署名付き埋め込みの削除を記録します。

フィールド
event.codesigned_embed.delete
scope.typeworkspace
resource.typesigned_embed
references(なし)
query(なし)
outbound(なし)
change(なし)
grant(なし)
extra(なし)

サンプル

json
{
  "event": {
    "code": "signed_embed.delete",
    ...
  },
  "scope": {
    "type": "workspace",
    ...
  },
  "resource": {
    "type": "signed_embed",
    "uid": "63e1be654aa70ad689601bf7",
    "name": "Partner Embed",
    "path": "notebook/63e1be654aa70ad689601bf3/signed_embed/63e1be654aa70ad689601bf7",
    "parts": [
      {
        "type": "notebook",
        "uid": "63e1be654aa70ad689601bf3",
        "name": "Sales KPI"
      },
      {
        "type": "signed_embed",
        "uid": "63e1be654aa70ad689601bf7",
        "name": "Partner Embed"
      }
    ],
    ...
  },
  ...
}

Codatum Audit Events 監査ログイベントカタログ