Files
openclaw/docs/gateway/authentication.md

117 lines
3.2 KiB
Markdown
Raw Normal View History

2026-01-09 00:32:48 +00:00
---
summary: "Model authentication: OAuth, API keys, and Claude Code token reuse"
read_when:
- Debugging model auth or OAuth expiry
- Documenting authentication or credential storage
---
# Authentication
2026-01-09 00:32:48 +00:00
Clawdbot supports OAuth and API keys for model providers. For Anthropic
subscription accounts, the most stable path is to **reuse Claude Code OAuth
credentials**, including the 1year token created by `claude setup-token`.
2026-01-09 00:32:48 +00:00
See [/concepts/oauth](/concepts/oauth) for the full OAuth flow and storage
layout.
2026-01-09 15:29:50 +01:00
## Preferred Anthropic setup (Claude CLI setup-token)
For Anthropic, the **preferred** path is the Claude CLI setup-token, not an API key.
Run it on the **gateway host**:
```bash
claude setup-token
```
Then verify and sync into Clawdbot:
```bash
clawdbot models status
clawdbot doctor
```
2026-01-09 00:32:48 +00:00
## Recommended: longlived Claude Code token
Run this on the **gateway host** (the machine running the Gateway):
```bash
claude setup-token
```
2026-01-09 00:32:48 +00:00
This issues a longlived **OAuth token** (not an API key) and stores it for
Claude Code. Then sync and verify:
```bash
2026-01-09 00:32:48 +00:00
clawdbot models status
clawdbot doctor
```
2026-01-09 00:32:48 +00:00
Automation-friendly check (exit `1` when expired/missing, `2` when expiring):
```bash
2026-01-09 00:32:48 +00:00
clawdbot models status --check
```
2026-01-09 00:32:48 +00:00
Optional ops scripts (systemd/Termux) are documented here:
[/automation/auth-monitoring](/automation/auth-monitoring)
2026-01-09 00:32:48 +00:00
`clawdbot models status` loads Claude Code credentials into Clawdbots
`auth-profiles.json` and shows expiry (warns within 24h by default).
`clawdbot doctor` also performs the sync when it runs.
2026-01-09 00:32:48 +00:00
> `claude setup-token` requires an interactive TTY.
2026-01-09 00:32:48 +00:00
## Checking model auth status
```bash
2026-01-09 00:32:48 +00:00
clawdbot models status
clawdbot doctor
```
2026-01-09 14:17:49 +00:00
## Controlling which credential is used
### Per-session (chat command)
Use `/model <alias-or-id>@<profileId>` to pin a specific provider credential for the current session (example profile ids: `anthropic:claude-cli`, `anthropic:default`). Use `/model status` to see candidates + which one is next.
### Per-agent (CLI override)
Set an explicit auth profile order override for an agent (stored in that agents `auth-profiles.json`):
```bash
clawdbot models auth order get --provider anthropic
clawdbot models auth order set --provider anthropic anthropic:claude-cli
clawdbot models auth order clear --provider anthropic
```
Use `--agent <id>` to target a specific agent; omit it to use the configured default agent.
2026-01-09 00:32:48 +00:00
## How sync works
2026-01-09 00:32:48 +00:00
1. **Claude Code** stores credentials in `~/.claude/.credentials.json` (or
Keychain on macOS).
2. **Clawdbot** syncs those into
`~/.clawdbot/agents/<agentId>/agent/auth-profiles.json` when the auth store is
loaded.
3. OAuth refresh happens automatically on use if a token is expired.
2026-01-09 00:32:48 +00:00
## Troubleshooting
2026-01-09 00:32:48 +00:00
### “No credentials found”
2026-01-09 00:32:48 +00:00
If the Anthropic OAuth profile is missing, run `claude setup-token` on the
**gateway host**, then re-check:
```bash
2026-01-09 00:32:48 +00:00
clawdbot models status
```
2026-01-09 00:32:48 +00:00
### Token expiring/expired
Run `clawdbot models status` to confirm which profile is expiring. If the profile
is `anthropic:claude-cli`, rerun `claude setup-token`.
## Requirements
2026-01-09 00:32:48 +00:00
- Claude Max or Pro subscription (for `claude setup-token`)
- Claude Code CLI installed (`claude` command available)