​

Secrets apply plan contract

​

Plan file shape

{
  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" },
    },
  ],
}

​

Supported target scope

• SecretRef Credential Surface

​

Target type behavior

• target.type must be recognized and must match the normalized target.path shape.

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

​

Path validation rules

• type must be a recognized target type.
• path must be a non-empty dot path.
• pathSegments can be omitted. If provided, it must normalize to exactly the same path as path.
• Forbidden segments are rejected: __proto__, prototype, constructor.
• The normalized path must match the registered path shape for the target type.
• If providerId or accountId is set, it must match the id encoded in the path.
• auth-profiles.json targets require agentId.
• When creating a new auth-profiles.json mapping, include authProfileProvider.

​

Failure behavior

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

​

Runtime and audit scope notes

• Ref-only auth-profiles.json entries (keyRef/tokenRef) are included in runtime resolution and audit coverage.
• secrets apply writes supported openclaw.json targets, supported auth-profiles.json targets, and optional scrub targets.

​

Operator checks

# 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

​

Related docs

• Secrets Management
• CLI secrets
• SecretRef Credential Surface
• Configuration Reference