Hợp đồng kế hoạch áp dụng bí mật

Documentation Index

Fetch the complete documentation index at: https://docs.openclaw.ai/llms.txt

Use this file to discover all available pages before exploring further.

​

Hình dạng tệp kế hoạch

{
  version: 1,
  protocolVersion: 1,
  targets: [
    {
      type: "models.providers.apiKey",
      path: "models.providers.openai.apiKey",
      pathSegments: ["models", "providers", "openai", "apiKey"],
      providerId: "openai",
      ref: { source: "env", provider: "default", id: "OPENAI_API_KEY" },
    },
    {
      type: "auth-profiles.api_key.key",
      path: "profiles.openai:default.key",
      pathSegments: ["profiles", "openai:default", "key"],
      agentId: "main",
      ref: { source: "env", provider: "default", id: "OPENAI_API_KEY" },
    },
  ],
}

​

Phạm vi mục tiêu được hỗ trợ

• Bề mặt thông tin xác thực SecretRef

​

Hành vi kiểu mục tiêu

• target.type phải được nhận diện và phải khớp với hình dạng target.path đã chuẩn hóa.

• models.providers.apiKey
• skills.entries.apiKey
• channels.googlechat.serviceAccount

​

Quy tắc xác thực đường dẫn

• type phải là một kiểu mục tiêu được nhận diện.
• path phải là một đường dẫn dấu chấm không rỗng.
• Có thể bỏ qua pathSegments. Nếu được cung cấp, nó phải chuẩn hóa thành đúng cùng một đường dẫn với path.
• Các phân đoạn bị cấm sẽ bị từ chối: __proto__, prototype, constructor.
• Đường dẫn đã chuẩn hóa phải khớp với hình dạng đường dẫn đã đăng ký cho kiểu mục tiêu.
• Nếu providerId hoặc accountId được đặt, nó phải khớp với mã định danh được mã hóa trong đường dẫn.
• Các mục tiêu auth-profiles.json yêu cầu agentId.
• Khi tạo một ánh xạ auth-profiles.json mới, hãy bao gồm authProfileProvider.

​

Hành vi thất bại

Invalid plan target path for models.providers.apiKey: models.providers.openai.baseUrl

​

Hành vi đồng ý của nhà cung cấp exec

• --dry-run bỏ qua các kiểm tra SecretRef exec theo mặc định.
• Các kế hoạch chứa SecretRef/nhà cung cấp exec sẽ bị từ chối ở chế độ ghi trừ khi --allow-exec được đặt.
• Khi xác thực/áp dụng các kế hoạch chứa exec, hãy truyền --allow-exec trong cả lệnh dry-run và lệnh ghi.

​

Ghi chú về phạm vi runtime và kiểm toán

• Các mục nhập auth-profiles.json chỉ tham chiếu (keyRef/tokenRef) được đưa vào quá trình phân giải runtime và phạm vi kiểm toán.
• secrets apply ghi các mục tiêu openclaw.json được hỗ trợ, các mục tiêu auth-profiles.json được hỗ trợ, và các mục tiêu scrub tùy chọn.

​

Kiểm tra dành cho người vận hành

# Validate plan without writes
openclaw secrets apply --from /tmp/openclaw-secrets-plan.json --dry-run

# Then apply for real
openclaw secrets apply --from /tmp/openclaw-secrets-plan.json

# For exec-containing plans, opt in explicitly in both modes
openclaw secrets apply --from /tmp/openclaw-secrets-plan.json --dry-run --allow-exec
openclaw secrets apply --from /tmp/openclaw-secrets-plan.json --allow-exec

​

Tài liệu liên quan

• Quản lý bí mật
• CLI secrets
• Bề mặt thông tin xác thực SecretRef
• Tham chiếu cấu hình