Initial commit
This commit is contained in:
Zhongwei Li
200
skills/working-with-claude-code/references/iam.md
Normal file
200
skills/working-with-claude-code/references/iam.md
Normal file
@@ -0,0 +1,200 @@
|
||||
# Identity and Access Management
|
||||
|
||||
> Learn how to configure user authentication, authorization, and access controls for Claude Code in your organization.
|
||||
|
||||
## Authentication methods
|
||||
|
||||
Setting up Claude Code requires access to Anthropic models. For teams, you can set up Claude Code access in one of three ways:
|
||||
|
||||
* Claude API via the Claude Console
|
||||
* Amazon Bedrock
|
||||
* Google Vertex AI
|
||||
|
||||
### Claude API authentication
|
||||
|
||||
**To set up Claude Code access for your team via Claude API:**
|
||||
|
||||
1. Use your existing Claude Console account or create a new Claude Console account
|
||||
2. You can add users through either method below:
|
||||
* Bulk invite users from within the Console (Console -> Settings -> Members -> Invite)
|
||||
* [Set up SSO](https://support.claude.com/en/articles/10280258-setting-up-single-sign-on-on-the-api-console)
|
||||
3. When inviting users, they need one of the following roles:
|
||||
* "Claude Code" role means users can only create Claude Code API keys
|
||||
* "Developer" role means users can create any kind of API key
|
||||
4. Each invited user needs to complete these steps:
|
||||
* Accept the Console invite
|
||||
* [Check system requirements](/en/docs/claude-code/setup#system-requirements)
|
||||
* [Install Claude Code](/en/docs/claude-code/setup#installation)
|
||||
* Login with Console account credentials
|
||||
|
||||
### Cloud provider authentication
|
||||
|
||||
**To set up Claude Code access for your team via Bedrock or Vertex:**
|
||||
|
||||
1. Follow the [Bedrock docs](/en/docs/claude-code/amazon-bedrock) or [Vertex docs](/en/docs/claude-code/google-vertex-ai)
|
||||
2. Distribute the environment variables and instructions for generating cloud credentials to your users. Read more about how to [manage configuration here](/en/docs/claude-code/settings).
|
||||
3. Users can [install Claude Code](/en/docs/claude-code/setup#installation)
|
||||
|
||||
## Access control and permissions
|
||||
|
||||
We support fine-grained permissions so that you're able to specify exactly what the agent is allowed to do (e.g. run tests, run linter) and what it is not allowed to do (e.g. update cloud infrastructure). These permission settings can be checked into version control and distributed to all developers in your organization, as well as customized by individual developers.
|
||||
|
||||
### Permission system
|
||||
|
||||
Claude Code uses a tiered permission system to balance power and safety:
|
||||
|
||||
| Tool Type | Example | Approval Required | "Yes, don't ask again" Behavior |
|
||||
| :---------------- | :------------------- | :---------------- | :-------------------------------------------- |
|
||||
| Read-only | File reads, LS, Grep | No | N/A |
|
||||
| Bash Commands | Shell execution | Yes | Permanently per project directory and command |
|
||||
| File Modification | Edit/write files | Yes | Until session end |
|
||||
|
||||
### Configuring permissions
|
||||
|
||||
You can view & manage Claude Code's tool permissions with `/permissions`. This UI lists all permission rules and the settings.json file they are sourced from.
|
||||
|
||||
* **Allow** rules will allow Claude Code to use the specified tool without further manual approval.
|
||||
* **Ask** rules will ask the user for confirmation whenever Claude Code tries to use the specified tool. Ask rules take precedence over allow rules.
|
||||
* **Deny** rules will prevent Claude Code from using the specified tool. Deny rules take precedence over allow and ask rules.
|
||||
* **Additional directories** extend Claude's file access to directories beyond the initial working directory.
|
||||
* **Default mode** controls Claude's permission behavior when encountering new requests.
|
||||
|
||||
Permission rules use the format: `Tool` or `Tool(optional-specifier)`
|
||||
|
||||
A rule that is just the tool name matches any use of that tool. For example, adding `Bash` to the list of allow rules would allow Claude Code to use the Bash tool without requiring user approval.
|
||||
|
||||
#### Permission modes
|
||||
|
||||
Claude Code supports several permission modes that can be set as the `defaultMode` in [settings files](/en/docs/claude-code/settings#settings-files):
|
||||
|
||||
| Mode | Description |
|
||||
| :------------------ | :--------------------------------------------------------------------------- |
|
||||
| `default` | Standard behavior - prompts for permission on first use of each tool |
|
||||
| `acceptEdits` | Automatically accepts file edit permissions for the session |
|
||||
| `plan` | Plan Mode - Claude can analyze but not modify files or execute commands |
|
||||
| `bypassPermissions` | Skips all permission prompts (requires safe environment - see warning below) |
|
||||
|
||||
#### Working directories
|
||||
|
||||
By default, Claude has access to files in the directory where it was launched. You can extend this access:
|
||||
|
||||
* **During startup**: Use `--add-dir <path>` CLI argument
|
||||
* **During session**: Use `/add-dir` slash command
|
||||
* **Persistent configuration**: Add to `additionalDirectories` in [settings files](/en/docs/claude-code/settings#settings-files)
|
||||
|
||||
Files in additional directories follow the same permission rules as the original working directory - they become readable without prompts, and file editing permissions follow the current permission mode.
|
||||
|
||||
#### Tool-specific permission rules
|
||||
|
||||
Some tools support more fine-grained permission controls:
|
||||
|
||||
**Bash**
|
||||
|
||||
* `Bash(npm run build)` Matches the exact Bash command `npm run build`
|
||||
* `Bash(npm run test:*)` Matches Bash commands starting with `npm run test`
|
||||
* `Bash(curl http://site.com/:*)` Matches curl commands that start with exactly `curl http://site.com/`
|
||||
|
||||
<Tip>
|
||||
Claude Code is aware of shell operators (like `&&`) so a prefix match rule like `Bash(safe-cmd:*)` won't give it permission to run the command `safe-cmd && other-cmd`
|
||||
</Tip>
|
||||
|
||||
<Warning>
|
||||
Important limitations of Bash permission patterns:
|
||||
|
||||
1. This tool uses **prefix matches**, not regex or glob patterns
|
||||
2. The wildcard `:*` only works at the end of a pattern to match any continuation
|
||||
3. Patterns like `Bash(curl http://github.com/:*)` can be bypassed in many ways:
|
||||
* Options before URL: `curl -X GET http://github.com/...` won't match
|
||||
* Different protocol: `curl https://github.com/...` won't match
|
||||
* Redirects: `curl -L http://bit.ly/xyz` (redirects to github)
|
||||
* Variables: `URL=http://github.com && curl $URL` won't match
|
||||
* Extra spaces: `curl http://github.com` won't match
|
||||
|
||||
For more reliable URL filtering, consider:
|
||||
|
||||
* Using the WebFetch tool with `WebFetch(domain:github.com)` permission
|
||||
* Instructing Claude Code about your allowed curl patterns via CLAUDE.md
|
||||
* Using hooks for custom permission validation
|
||||
</Warning>
|
||||
|
||||
**Read & Edit**
|
||||
|
||||
`Edit` rules apply to all built-in tools that edit files. Claude will make a best-effort attempt to apply `Read` rules to all built-in tools that read files like Grep, Glob, and LS.
|
||||
|
||||
Read & Edit rules both follow the [gitignore](https://git-scm.com/docs/gitignore) specification with four distinct pattern types:
|
||||
|
||||
| Pattern | Meaning | Example | Matches |
|
||||
| ------------------ | -------------------------------------- | -------------------------------- | ---------------------------------- |
|
||||
| `//path` | **Absolute** path from filesystem root | `Read(//Users/alice/secrets/**)` | `/Users/alice/secrets/**` |
|
||||
| `~/path` | Path from **home** directory | `Read(~/Documents/*.pdf)` | `/Users/alice/Documents/*.pdf` |
|
||||
| `/path` | Path **relative to settings file** | `Edit(/src/**/*.ts)` | `<settings file path>/src/**/*.ts` |
|
||||
| `path` or `./path` | Path **relative to current directory** | `Read(*.env)` | `<cwd>/*.env` |
|
||||
|
||||
<Warning>
|
||||
A pattern like `/Users/alice/file` is NOT an absolute path - it's relative to your settings file! Use `//Users/alice/file` for absolute paths.
|
||||
</Warning>
|
||||
|
||||
* `Edit(/docs/**)` - Edits in `<project>/docs/` (NOT `/docs/`!)
|
||||
* `Read(~/.zshrc)` - Reads your home directory's `.zshrc`
|
||||
* `Edit(//tmp/scratch.txt)` - Edits the absolute path `/tmp/scratch.txt`
|
||||
* `Read(src/**)` - Reads from `<current-directory>/src/`
|
||||
|
||||
**WebFetch**
|
||||
|
||||
* `WebFetch(domain:example.com)` Matches fetch requests to example.com
|
||||
|
||||
**MCP**
|
||||
|
||||
* `mcp__puppeteer` Matches any tool provided by the `puppeteer` server (name configured in Claude Code)
|
||||
* `mcp__puppeteer__puppeteer_navigate` Matches the `puppeteer_navigate` tool provided by the `puppeteer` server
|
||||
|
||||
<Warning>
|
||||
Unlike other permission types, MCP permissions do NOT support wildcards (`*`).
|
||||
|
||||
To approve all tools from an MCP server:
|
||||
|
||||
* ✅ Use: `mcp__github` (approves ALL GitHub tools)
|
||||
* ❌ Don't use: `mcp__github__*` (wildcards are not supported)
|
||||
|
||||
To approve specific tools only, list each one:
|
||||
|
||||
* ✅ Use: `mcp__github__get_issue`
|
||||
* ✅ Use: `mcp__github__list_issues`
|
||||
</Warning>
|
||||
|
||||
### Additional permission control with hooks
|
||||
|
||||
[Claude Code hooks](/en/docs/claude-code/hooks-guide) provide a way to register custom shell commands to perform permission evaluation at runtime. When Claude Code makes a tool call, PreToolUse hooks run before the permission system runs, and the hook output can determine whether to approve or deny the tool call in place of the permission system.
|
||||
|
||||
### Enterprise managed policy settings
|
||||
|
||||
For enterprise deployments of Claude Code, we support enterprise managed policy settings that take precedence over user and project settings. This allows system administrators to enforce security policies that users cannot override.
|
||||
|
||||
System administrators can deploy policies to:
|
||||
|
||||
* macOS: `/Library/Application Support/ClaudeCode/managed-settings.json`
|
||||
* Linux and WSL: `/etc/claude-code/managed-settings.json`
|
||||
* Windows: `C:\ProgramData\ClaudeCode\managed-settings.json`
|
||||
|
||||
These policy files follow the same format as regular [settings files](/en/docs/claude-code/settings#settings-files) but cannot be overridden by user or project settings. This ensures consistent security policies across your organization.
|
||||
|
||||
### Settings precedence
|
||||
|
||||
When multiple settings sources exist, they are applied in the following order (highest to lowest precedence):
|
||||
|
||||
1. Enterprise policies
|
||||
2. Command line arguments
|
||||
3. Local project settings (`.claude/settings.local.json`)
|
||||
4. Shared project settings (`.claude/settings.json`)
|
||||
5. User settings (`~/.claude/settings.json`)
|
||||
|
||||
This hierarchy ensures that organizational policies are always enforced while still allowing flexibility at the project and user levels where appropriate.
|
||||
|
||||
## Credential management
|
||||
|
||||
Claude Code securely manages your authentication credentials:
|
||||
|
||||
* **Storage location**: On macOS, API keys, OAuth tokens, and other credentials are stored in the encrypted macOS Keychain.
|
||||
* **Supported authentication types**: Claude.ai credentials, Claude API credentials, Bedrock Auth, and Vertex Auth.
|
||||
* **Custom credential scripts**: The [`apiKeyHelper`](/en/docs/claude-code/settings#available-settings) setting can be configured to run a shell script that returns an API key.
|
||||
* **Refresh intervals**: By default, `apiKeyHelper` is called after 5 minutes or on HTTP 401 response. Set `CLAUDE_CODE_API_KEY_HELPER_TTL_MS` environment variable for custom refresh intervals.
|
||||
Reference in New Issue
Block a user