CLAUDE_BG_SESSION_CREDENTIAL

Updated by

CLAUDE_BG_SESSION_CREDENTIAL is a Claude Code environment variable: Supplies the credential for a background session; it is read only when a gating check passes and is used only if the value validates, otherwise ignored. Added between v2.1.321 and v2.1.323 and still present in v2.1.324. It is not in the official reference.

StatusPresent in v2.1.324
AddedAdded between v2.1.321 and v2.1.323
CategoryAuthentication
Official docsNot listed

How to set it

For one session, export it in the shell that starts Claude Code:

export CLAUDE_BG_SESSION_CREDENTIAL=<value>
claude

To apply it to every session, add it to the env object of a settings file:

// ~/.claude/settings.json
{
  "env": {
    "CLAUDE_BG_SESSION_CREDENTIAL": "<value>"
  }
}

Related variables

Frequently asked questions

What does CLAUDE_BG_SESSION_CREDENTIAL do?

Supplies the credential for a background session; it is read only when a gating check passes and is used only if the value validates, otherwise ignored.

Which Claude Code version has CLAUDE_BG_SESSION_CREDENTIAL?

Added between v2.1.321 and v2.1.323 and still present in v2.1.324.

How do I set CLAUDE_BG_SESSION_CREDENTIAL?

Export it before starting Claude Code (export CLAUDE_BG_SESSION_CREDENTIAL=value), or add it to the "env" object in ~/.claude/settings.json to apply it to every session.

All variables, searchable: Claude Code environment variables.