Appearance
References
Envelope の references は、操作対象そのものではないものの、そのイベントに関係するリソースを記録します。 たとえば複製元のノートブックが relation に source を持つ参照として入ります。 どのような関係を記録するかは RelationType を参照してください。
操作対象自身の属性として表せるもの(配置先のフォルダ階層など)は references ではなく change に入ります。
各要素は RelatedReference で、 Reference に操作対象との関係(relation)を足した形です。 references が付くかどうかはイベントの種類ごとに決まっており(change / grant と同じです)、 どの relation の参照が付くかは各イベントページに記載しています。
resource との違い
操作対象は resource、それ以外は references で表します。
resource | references | |
|---|---|---|
| 表すもの | 操作対象 | 操作対象以外の関連リソース |
| 件数 | 常に1つ | 0件以上(配列) |
階層(path / parts) | あり | なし |
| 要素の型 | Resource | RelatedReference |
| 種類の一覧 | ResourceType | ReferenceType |
表示名の表記
種類によって、表示に使うフィールドが変わります。
type | 使うフィールド |
|---|---|
user / invitation | email_addr |
| それ以外 | name |
email_addr はマスクせずそのまま記録します(actor.principal.email_addr と同じ)。
name や email_addr はキャッシュを利用するため、古い値のまま記録されることがあります。 対象を絞り込む際は uid をご利用ください。
Objects
RelatedReference
references の要素1件分です。 Reference に、操作対象との関係を表す relation を足した形です。
配列内の順序に意味はありません。複数件ある場合は、各エントリの relation で関係を判別します。
| 名前 | 型 | 必須 | 説明 |
|---|---|---|---|
relation | RelationType | 必須 | 操作対象との関係 |
type | ReferenceType | 必須 | 参照先のリソースの種類 |
uid | string | 必須 | 参照先のリソースの識別子 |
name | string | 任意 | イベント発生時点の表示名。user / invitation 以外の種類で使います。sensitivity: pii |
email_addr | string | 任意 | 参照先のメールアドレス。type が user / invitation のときに使います。sensitivity: pii |
Reference
操作対象以外のリソースを、種類(type)と識別子(uid)で指します。 あわせて、ログを読むときの手がかりとして表示名(user / invitation の場合は email_addr)を持ちます。
RelatedReference で利用する他に、 grant の target / grantee、context の経路情報、 change / extra でも利用します。
| 名前 | 型 | 必須 | 説明 |
|---|---|---|---|
type | ReferenceType | 必須 | 参照先のリソースの種類 |
uid | string | 必須 | 参照先のリソースの識別子 |
name | string | 任意 | イベント発生時点の表示名。user / invitation 以外の種類で使います。sensitivity: pii |
email_addr | string | 任意 | 参照先のメールアドレス。type が user / invitation のときに使います。sensitivity: pii |
Enums
RelationType
操作対象と関連リソースの関係です。
| 値 | 説明 |
|---|---|
source | 複製元・復元元 |
api_key | 許可 APIキー |
invitation | 対象となった招待 |
invite_link | 参加に使われた招待リンク |
ReferenceType
操作対象以外として参照されるリソースの種類です。
| 値 | 説明 |
|---|---|
agent_session | AIエージェントのセッション |
ai_profile | AIプロファイル |
api_key | APIキー |
connection | コネクション |
notebook_folder | ノートブックフォルダ |
group | グループ |
invitation | 招待 |
invite_link | 招待リンク |
mcp_client | MCPクライアント |
mcp_oauth_session | MCPのOAuth接続(認可で作られた接続1本) |
notebook | ノートブック |
notebook_page | ノートブックのページ |
notebook_version | ノートブックのバージョン |
report | レポート |
signed_embed | 署名付き埋め込み |
teamspace | チームスペース |
user | ユーザー |
workflow | ワークフロー |
workflow_job | ワークフローの実行1回分 |
workflow_step | ワークフローのステップ |
workspace | ワークスペース |