Skip to content

References

Envelope の references は、操作対象そのものではないものの、そのイベントに関係するリソースを記録します。 たとえば複製元のノートブックが relationsource を持つ参照として入ります。 どのような関係を記録するかは RelationType を参照してください。

操作対象自身の属性として表せるもの(配置先のフォルダ階層など)は references ではなく change に入ります。

各要素は RelatedReference で、 Reference に操作対象との関係(relation)を足した形です。 references が付くかどうかはイベントの種類ごとに決まっており(change / grant と同じです)、 どの relation の参照が付くかは各イベントページに記載しています。

resource との違い

操作対象は resource、それ以外は references で表します。

resourcereferences
表すもの操作対象操作対象以外の関連リソース
件数常に1つ0件以上(配列)
階層(path / partsありなし
要素の型ResourceRelatedReference
種類の一覧ResourceTypeReferenceType

表示名の表記

種類によって、表示に使うフィールドが変わります。

type使うフィールド
user / invitationemail_addr
それ以外name

email_addr はマスクせずそのまま記録します(actor.principal.email_addr と同じ)。

nameemail_addr はキャッシュを利用するため、古い値のまま記録されることがあります。 対象を絞り込む際は uid をご利用ください。

Objects

RelatedReference

references の要素1件分です。 Reference に、操作対象との関係を表す relation を足した形です。

配列内の順序に意味はありません。複数件ある場合は、各エントリの relation で関係を判別します。

名前必須説明
relationRelationType必須操作対象との関係
typeReferenceType必須参照先のリソースの種類
uidstring必須参照先のリソースの識別子
namestring任意イベント発生時点の表示名。user / invitation 以外の種類で使います。
sensitivity: pii
email_addrstring任意参照先のメールアドレス。typeuser / invitation のときに使います。
sensitivity: pii

Reference

操作対象以外のリソースを、種類(type)と識別子(uid)で指します。 あわせて、ログを読むときの手がかりとして表示名(user / invitation の場合は email_addr)を持ちます。

RelatedReference で利用する他に、 granttarget / granteecontext の経路情報、 change / extra でも利用します。

名前必須説明
typeReferenceType必須参照先のリソースの種類
uidstring必須参照先のリソースの識別子
namestring任意イベント発生時点の表示名。user / invitation 以外の種類で使います。
sensitivity: pii
email_addrstring任意参照先のメールアドレス。typeuser / invitation のときに使います。
sensitivity: pii

Enums

RelationType

操作対象と関連リソースの関係です。

説明
source複製元・復元元
api_key許可 APIキー
invitation対象となった招待
invite_link参加に使われた招待リンク

ReferenceType

操作対象以外として参照されるリソースの種類です。

説明
agent_sessionAIエージェントのセッション
ai_profileAIプロファイル
api_keyAPIキー
connectionコネクション
notebook_folderノートブックフォルダ
groupグループ
invitation招待
invite_link招待リンク
mcp_clientMCPクライアント
mcp_oauth_sessionMCPのOAuth接続(認可で作られた接続1本)
notebookノートブック
notebook_pageノートブックのページ
notebook_versionノートブックのバージョン
reportレポート
signed_embed署名付き埋め込み
teamspaceチームスペース
userユーザー
workflowワークフロー
workflow_jobワークフローの実行1回分
workflow_stepワークフローのステップ
workspaceワークスペース

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