Skip to content

Credentials

Store provider and extension credentials for one profile without exposing secret values or sharing profile-owned state.

For people running agent work7 pages in this section

Profile credentials are write-only Vault overrides. The permanent default profile uses the user credential namespace; every other profile gets its own owner prefix.

Active profileProvider refExtension ref
defaultvault:providers/<provider>/<slot>vault:extensions/<extension>/<key>
<name>vault:profiles/<name>/providers/<provider>/<slot>vault:profiles/<name>/extensions/<extension>/<key>

Set and inspect a provider credential

Pass the value through standard input so it does not enter shell history:

printf '%s' "$ANTHROPIC_API_KEY" |
  compozy --profile marketing secret set providers/claude/api_key --value-stdin -o json

compozy --profile marketing provider inspect claude -o json

secret set returns only ref, profile, and status. provider inspect shows the effective credential source and fallback chain without returning the credential value.

--from-env is available only for the default profile. A process environment is shared by every profile, so a non-default profile rejects it with profile_secret_env_forbidden and directs you to --value-stdin.

Extension credentials use the same journey:

printf '%s' "$LINEAR_TOKEN" |
  compozy --profile marketing secret set extensions/linear/token --value-stdin -o json

Remove an override

compozy --profile marketing secret rm providers/claude/api_key -o json

When the profile owns work, interactive output warns that future runs will fall back to the user credential. Structured or non-interactive callers must acknowledge that transition with --yes:

compozy --profile marketing secret rm providers/claude/api_key --yes -o json

Removal never deletes the user credential. Read provider inspect again to confirm the effective source before starting new work.

Profile lifecycle

Profile rename moves owned Vault refs to the new owner prefix as part of the rename plan. Profile deletion includes credential overrides in its impact plan. Complete or recover the profile operation instead of editing Vault paths directly.

Agent-managed surfaces

The same credential metadata and profile ownership are available through HTTP and UDS Vault and provider-status endpoints. Secret values remain write-only on every surface. Agents should resolve the live descriptor, write the exact owner-qualified ref, then verify the redacted provider source.

Create your first profile walks through setting an override in context. Profile files lists the rest of what a profile owns on disk, and Extension secrets covers the extension side of the same binding rule.

On this page