Context

Envelope の context は、その操作がどの経路から行われたかを表します。 経路ごとにフィールドが分かれており、該当する経路のフィールドだけが入ります。 経路を持たない操作では、Envelope から context 自体が付きません。

Objects

Context

操作の経路に関する情報です。 経路によって、入るフィールドと記録される内容が変わります。

名前	型	必須	説明
notebook	Notebook	任意	ノートブックの編集画面経由の操作のときに入ります。
report	Report	任意	レポート経由の操作のときに入ります。
signed_embed	SignedEmbed	任意	署名付き埋め込み経由の操作のときに入ります。
workflow	Workflow	任意	ワークフローの実行経由の操作のときに入ります。
ai_agent	AiAgent	任意	AIエージェント経由の操作のときに入ります。
mcp	Mcp	任意	MCPクライアント経由の操作のときに入ります。
pat	Pat	任意	PAT 経由の操作のときに入ります。

Notebook

ノートブックの編集画面経由の操作の情報です。 編集中の操作では、操作者はユーザーのままですが、 どのノートブック・どのページから行われたかをこのオブジェクトで表します。

ここに入るノートブック・ページは、操作元が申告した経路の情報です。 権限の判定は操作対象のリソースに対して行われるため、 この値は操作を辿るための参考情報として扱ってください。

ノートブック自身への操作には付きません。 編集中に、ノートブックの外にあるリソース（クエリジョブやテーブルなど）を 操作したときに付きます。

名前	型	必須	説明
notebook	Reference	必須	編集中のノートブック
page	Reference	必須	操作時に開いていたページ。編集中にページを切り替えられるため、 操作ごとに異なる値が入ることがあります。

Report

レポート経由の操作の情報です。 レポート閲覧中の操作では、操作者はユーザーのままですが、 どのレポート・どのページから行われたかをこのオブジェクトで表します。

名前	型	必須	説明
report	Reference	必須	閲覧されたレポート
notebook	Reference	必須	レポートの公開元ノートブック
page	Reference	必須	操作時に開いていたページ。レポートは閲覧中にページを切り替えられるため、 操作ごとに異なる値が入ることがあります。

SignedEmbed

署名付き埋め込み経由の操作の情報です。

このオブジェクトの値は、すべてトークン発行時に確定したものです。 発行後に閲覧側で変更された値は含みません。

署名付き埋め込み経由では actor は APIキーになります。 どの埋め込みからどの閲覧者が操作したのかは、このオブジェクトから補えます。

名前	型	必須	説明
signed_embed	Reference	必須	使用された署名付き埋め込み
notebook	Reference	必須	埋め込み対象のノートブック
page	Reference	必須	埋め込み対象のページ。トークン発行時に固定され、閲覧中に変わることはありません。
token_user_id	string	任意	トークン発行時に閲覧者として指定された識別子。Codatum のユーザーではなく、埋め込み先のアプリケーションが管理する識別子です。 sensitivity: pii
params	SignedEmbedParam[]	任意	トークン発行時に指定されたパラメータ。発行後に閲覧側で変更された値は含みません。

Workflow

ワークフローの実行経由の操作の情報です。 実行中の操作では actor はワークフローになります。 どのワークフロー・どの実行から行われたのか、誰が起動したのかは、 このオブジェクトから補えます。

ワークフローやワークフロージョブ自身への操作には付きません。 実行中に、ワークフローの外にあるリソース（クエリジョブなど）を 操作したときに付きます。

名前	型	必須	説明
workflow	Reference	必須	実行されたワークフロー
workflow_job	Reference	必須	実行1回分。同じワークフローの実行でも、実行のたびに異なる値が入ります。 この値で、1回の実行から行われた操作をまとめられます。
step	Reference	任意	操作したステップ。uid はワークフロー内でステップを識別する値で、 表示名は持ちません。ステップに紐づかない操作では入りません。
triggered_by	Reference	任意	手動実行を開始したユーザーです。 スケジュール実行では入りません。

AiAgent

AIエージェント経由の操作の情報です。 操作者はユーザーのままですが、どのセッションから行われたかを このオブジェクトで表します。

AIエージェント自身への操作には付きません。 実行中に、セッションの外にあるリソース（クエリジョブなど）を 操作したときに付きます。

旧機能のAIアシスタントや、セッションを持たない MCP の直接実行には付きません。 MCP からエージェントセッションを起動したときは、mcp も併せて付きます。

名前	型	必須	説明
ai_profile	Reference	必須	その操作時に適用されていたAIプロファイル
session	Reference	必須	会話1本分。同じセッションからの操作をこの値でまとめられます。
tool	string	任意	使われたツールの名前。ツールに紐づかない操作では入りません。

Mcp

MCPクライアント経由の操作の情報です。 操作者は actor に入り、どのMCPクライアントのどのMCP接続から 行われたかをこのオブジェクトで表します。

PAT と同様、認証の方式を表すものなので、AIエージェントなどの実行経路と 同時に付くことがあります。 セッションを持たない直接実行では、このオブジェクトだけが入ります。

名前	型	必須	説明
client	Reference	必須	接続したMCPクライアント
oauth_session	Reference	必須	認可で作られたMCP接続1本。ワークスペース設定のMCP接続一覧と同じ値です。 表示名は持ちません。
scopes	string[]	任意	このMCP接続に許可された操作の範囲

SignedEmbedParam

署名付き埋め込みトークン発行時のパラメータ1件。 param_uid は signed_embed.upsert_param / signed_embed.remove_param の resource.uid（実装の widget_id）と同じ値空間です。

名前	型	必須	説明
param_uid	string	必須	パラメータの識別子。 signed_embed_param の resource.uid および実装の widget_id と同じ値です。
value	string	必須	パラメータの値（文字列に変換済み） sensitivity: pii
overwrite_type	SignedEmbedParamOverwriteType	必須	パラメータの上書き方法

Pat

PAT 経由の操作の情報です。 PAT には許可する操作の範囲を設定できるため、その操作がどの範囲の下で行われたのかを記録します。

名前	型	必須	説明
boundary	string[]	任意	この PAT に許可された操作の範囲。指定がない場合は、ユーザー自身の権限がそのまま適用されます。