SPB Git

Repository Public

admin-api-keys.md 15.0 KB


# title: Create an Admin API key url: https://platform.claude.com/docs/en/manage-claude/admin-api-keys description: Create an Admin API key for your Claude Console or Claude Enterprise organization.

An Admin API key authenticates every API in the Admin section of this guide: the Admin API, Analytics APIs, Compliance API, Spend Limits API, Usage and Cost API, and Rate Limits API. You do not need a separate key for each API. The one exception is the Admin API's service-account, federation-issuer, and federation-rule endpoints, which accept only an OAuth bearer token with the org:admin scope. See Obtain an OAuth bearer token.

Where you create the key depends on which Claude product your organization uses.

# Which key do you need?

Your organization Create the key in Key prefix Who can create it Works with
Claude Console (Claude Platform, platform.claude.com) Claude Console > Settings > Admin keys sk-ant-admin01-... Organization members with the admin role Admin API, Usage and Cost API, Rate Limits API, Claude Code Analytics API, and the Compliance API Activity Feed
Claude Enterprise (claude.ai) claude.ai > Organization settings > API sk-ant-api01-... The parent organization's primary owner (all linked organizations). An organization owner can create one carrying Compliance API scopes only, restricted to their own organization User management (the Admin API's member, invite, and group endpoints), Compliance API, Claude Enterprise Analytics API, and Spend Limits API, according to the scopes you select

A key created in one organization cannot be used to manage a different organization. If your company uses both Claude Console and Claude Enterprise, create one key in each.

# Create a key for a Claude Console organization

Only organization members with the **admin** role can create Admin API keys. See [Organization roles and permissions](https://platform.claude.com/docs/en/manage-claude/admin-api#organization-roles-and-permissions). Go to [Claude Console > Settings > Admin keys](https://platform.claude.com/settings/admin-keys). Click **Create key**, give it a name, choose a [key expiration](https://platform.claude.com/docs/en/manage-claude/authentication#key-expiration), and click **Create**. Claude Console keys do not have selectable scopes; every key carries full access to all endpoints that accept Admin API keys (the service-account and federation endpoints noted at the top of this page do not accept Admin API keys). Copy the displayed secret (starting with `sk-ant-admin01-`) and store it in your secrets manager. The full secret is shown only once.

# Create a key for a Claude Enterprise organization

The **primary owner** of the Claude Enterprise parent organization can create a key that can access every linked organization, or one restricted to a single organization. An **organization owner** can create a key with Compliance API scopes only, restricted to their own organization. Go to [claude.ai > Organization settings > API](https://claude.ai/admin-settings/api-access) and find the **Keys** section. Name the key and select the scopes you need from the [scopes table](https://platform.claude.com/docs/en/manage-claude/admin-api-keys#choose-scopes-for-a-claude-enterprise-key). The primary owner can combine scopes from different APIs (for example, `read:analytics` and `read:spend_limits`) on a single key. Copy the displayed secret (starting with `sk-ant-api01-`) and store it in your secrets manager. The full secret is shown only once.

# Choose scopes for a Claude Enterprise key

When you create a Claude Enterprise key, select every scope that the APIs you plan to call require. Scopes are fixed at creation; to add a scope later, create a new key.

To call... Select these scopes
Admin API user management: list and look up members and invites; read custom roles and their permissions read:members
Admin API user management: change member roles, remove members, create and withdraw invites write:members
Admin API user management: read groups and their members read:rbac_groups
Admin API user management: create, rename, and delete groups; add and remove group members; assign groups on invite creation write:rbac_groups
Spend Limits API: read members' effective spend limits and increase requests read:spend_limits
Spend Limits API: set or clear per-user spend limits; approve or deny increase requests write:spend_limits
Claude Enterprise Analytics API: engagement, adoption, cost, and usage reports read:analytics
Compliance API Activity Feed: organization-wide activity events read:compliance_activities
Compliance API chat, file, and project endpoints and Compliance API session endpoints: read chats, files, projects, session transcripts, and organization users read:compliance_user_data
Compliance API chat, file, and project endpoints: delete chats, files, and projects delete:compliance_user_data
Compliance API organization endpoints: read organization metadata and effective settings read:compliance_org_data
Admin API user management read endpoints and every Compliance API read endpoint, with a single read-only scope (for security-audit integrations; does not include the Spend Limits or Analytics APIs) read:org_audit

The Compliance and Analytics APIs must be enabled for your organization before keys with those scopes can be used. See Set up the Compliance API and Get access to the Claude Enterprise Analytics API.

# Use the key

Pass the key in the x-api-key header on every request. See each API's documentation for complete request examples.

A call that exceeds the key's scopes returns 403 Forbidden with a message listing the scopes the key has and the scopes the endpoint needs.

# Next steps

Manage organization members, workspaces, and API keys. Set per-member spend limits and review increase requests for your Claude Enterprise organization. Report on Claude Code productivity or Claude Enterprise engagement and adoption. Audit activity and retrieve or delete user content across your organization.
Files main
Menu

Theme