指令參考:OpenPort
用 Agent Key 讀取工作區和交易,提出或執行操作,並覆核草稿、匯出稽核紀錄。
概述
OpenPort 指令讓自動化流程在其 Agent Key 的權限範圍內讀取工作區資料、提出或執行操作。資料指令需要 Agent Key;覆核指令需要某個人的瀏覽器登入。所有指令都需要支援 OpenPort 的伺服器,覆核指令還需要伺服器支援審核功能。
讀取資料(Agent Key)
figena openport manifest
查看工具清單:你的 Agent Key 可以使用的操作和資料。
figena openport workspaces
列出你的 Agent Key 可以存取的工作區。
figena openport transactions
列出工作區中的交易。工作區來自 --workspace <id>(或 --org <id>),或 profile 中的 orgId。
--kind <kind>和--search <text>:篩選清單。--from <date>和--to <date>:限定日期範圍。--sort <order>、--page <n>和--page-size <n>:排序並分頁查看結果。
提出和執行操作(Agent Key)
figena openport preflight
在送出操作之前先做檢查,回傳操作的預期影響和 impactHash。--action <name> 為必填;用 --payload <file> 或 --payload-json '<json>' 傳入酬載。
figena openport action
用 --action <name> 和酬載建立一個操作。每個操作都會先記錄為草稿。加上 --execute 表示請求 Figena 立即執行,同時必須提供 --justification "<reason>",理由會隨操作一起儲存。能否執行取決於工作區為這把 Agent Key 設定的自動執行規則;不允許執行時,操作會保留為草稿等待覆核,結果中會說明原因。
--preflight-hash <hash>:openport preflight回傳的impactHash。高風險操作通常需要它才能執行,並且送出時它必須仍與目前的影響一致。--force-draft:把操作作為草稿送出覆核。--request-id <id>和--idempotency-key <key>:識別這次請求。帶冪等金鑰且不執行的請求,在暫時失敗後可能重試一次;CLI 從不重試已執行的操作。
figena openport preflight --action <action-name> --payload ./payload.jsonfigena openport action --action <action-name> --payload ./payload.json --force-draftfigena openport draft get <draftId>
查看一份草稿。
覆核草稿和匯出稽核紀錄(瀏覽器登入)
figena openport drafts list
列出等待覆核的草稿。可用 --app <appId>、--org <id> 和 --status <status> 篩選,用 --page-size <n>(或 --limit)和 --cursor <cursor> 分頁。加上 --all 會讀取所有頁面,--max-items <n> 會在達到指定數量後停止。結果包含 items、nextCursor 和已讀取的頁數 pages。
figena openport draft approve <draftId>
核准一份草稿。加上 --note "<text>" 可以記錄原因。
figena openport draft reject <draftId>
拒絕一份草稿。加上 --note "<text>" 可以記錄原因。
figena openport audit export
以 CSV 格式匯出 OpenPort 稽核記錄。可用 --app、--org、--from、--to 和 --limit 篩選。使用 --file <path> 時,CLI 會把 CSV 寫入該檔案,輸出「Exported audit CSV to」和檔案路徑,並附上列數;不使用時,CSV 會包含在結果資料中回傳。
figena openport audit export --org <workspace-id> --from <date> --to <date> --file ./openport-audit.csv