Администрирование и мониторинг

Обзор Admin API

Программно управляйте ресурсами вашей организации, включая участников организации, рабочие пространства и API ключи.

The Admin API is unavailable for individual accounts. To collaborate with teammates and add members, set up your organization in Console → Settings → Organization.

Admin API позволяет программно управлять ресурсами вашей организации, включая участников организации, рабочие пространства и API ключи. Это обеспечивает программный контроль над административными задачами, которые иначе потребовали бы ручной настройки в Claude Console.

Admin API требует специального доступа

Admin API требует специального Admin API ключа (начинающегося с sk-ant-admin...), который отличается от стандартных API ключей. Только участники организации с ролью администратора могут создавать Admin API ключи через Claude Console.

Как работает Admin API

Когда вы используете Admin API:

Вы делаете запросы, используя ваш Admin API ключ в заголовке x-api-key
API позволяет вам управлять:
- Участниками организации и их ролями
- Приглашениями участников организации
- Рабочими пространствами и их участниками
- API ключами

Это полезно для:

Автоматизации подключения/отключения пользователей
Программного управления доступом к рабочим пространствам
Мониторинга и управления использованием API ключей

Роли и разрешения организации

Существует пять ролей уровня организации. Подробнее см. здесь.

Роль	Разрешения
user	Может использовать Workbench
claude_code_user	Может использовать Workbench и Claude Code
developer	Может использовать Workbench и управлять API ключами
billing	Может использовать Workbench и управлять деталями биллинга
admin	Может делать все вышеперечисленное, плюс управлять пользователями

Ключевые концепции

Участники организации

Вы можете просматривать участников организации, обновлять роли участников и удалять участников.

Shell

# Список участников организации
curl "https://api.anthropic.com/v1/organizations/users?limit=10" \
  --header "anthropic-version: 2023-06-01" \
  --header "x-api-key: $ANTHROPIC_ADMIN_KEY"

# Обновить роль участника
curl "https://api.anthropic.com/v1/organizations/users/{user_id}" \
  --header "anthropic-version: 2023-06-01" \
  --header "x-api-key: $ANTHROPIC_ADMIN_KEY" \
  --data '{"role": "developer"}'

# Удалить участника
curl --request DELETE "https://api.anthropic.com/v1/organizations/users/{user_id}" \
  --header "anthropic-version: 2023-06-01" \
  --header "x-api-key: $ANTHROPIC_ADMIN_KEY"

Приглашения организации

Вы можете приглашать пользователей в организации и управлять этими приглашениями.

# Создать приглашение
curl --request POST "https://api.anthropic.com/v1/organizations/invites" \
  --header "anthropic-version: 2023-06-01" \
  --header "x-api-key: $ANTHROPIC_ADMIN_KEY" \
  --data '{
    "email": "[email protected]",
    "role": "developer"
  }'

# Список приглашений
curl "https://api.anthropic.com/v1/organizations/invites?limit=10" \
  --header "anthropic-version: 2023-06-01" \
  --header "x-api-key: $ANTHROPIC_ADMIN_KEY"

# Удалить приглашение
curl --request DELETE "https://api.anthropic.com/v1/organizations/invites/{invite_id}" \
  --header "anthropic-version: 2023-06-01" \
  --header "x-api-key: $ANTHROPIC_ADMIN_KEY"

Рабочие пространства

Создавайте и управляйте рабочими пространствами (консоль) для организации ваших ресурсов:

# Создать рабочее пространство
curl --request POST "https://api.anthropic.com/v1/organizations/workspaces" \
  --header "anthropic-version: 2023-06-01" \
  --header "x-api-key: $ANTHROPIC_ADMIN_KEY" \
  --data '{"name": "Production"}'

# Список рабочих пространств
curl "https://api.anthropic.com/v1/organizations/workspaces?limit=10&include_archived=false" \
  --header "anthropic-version: 2023-06-01" \
  --header "x-api-key: $ANTHROPIC_ADMIN_KEY"

# Архивировать рабочее пространство
curl --request POST "https://api.anthropic.com/v1/organizations/workspaces/{workspace_id}/archive" \
  --header "anthropic-version: 2023-06-01" \
  --header "x-api-key: $ANTHROPIC_ADMIN_KEY"

Участники рабочих пространств

Управляйте доступом пользователей к конкретным рабочим пространствам:

# Добавить участника в рабочее пространство
curl --request POST "https://api.anthropic.com/v1/organizations/workspaces/{workspace_id}/members" \
  --header "anthropic-version: 2023-06-01" \
  --header "x-api-key: $ANTHROPIC_ADMIN_KEY" \
  --data '{
    "user_id": "user_xxx",
    "workspace_role": "workspace_developer"
  }'

# Список участников рабочего пространства
curl "https://api.anthropic.com/v1/organizations/workspaces/{workspace_id}/members?limit=10" \
  --header "anthropic-version: 2023-06-01" \
  --header "x-api-key: $ANTHROPIC_ADMIN_KEY"

# Обновить роль участника
curl --request POST "https://api.anthropic.com/v1/organizations/workspaces/{workspace_id}/members/{user_id}" \
  --header "anthropic-version: 2023-06-01" \
  --header "x-api-key: $ANTHROPIC_ADMIN_KEY" \
  --data '{
    "workspace_role": "workspace_admin"
  }'

# Удалить участника из рабочего пространства
curl --request DELETE "https://api.anthropic.com/v1/organizations/workspaces/{workspace_id}/members/{user_id}" \
  --header "anthropic-version: 2023-06-01" \
  --header "x-api-key: $ANTHROPIC_ADMIN_KEY"

API ключи

Мониторинг и управление API ключами:

# Список API ключей
curl "https://api.anthropic.com/v1/organizations/api_keys?limit=10&status=active&workspace_id=wrkspc_xxx" \
  --header "anthropic-version: 2023-06-01" \
  --header "x-api-key: $ANTHROPIC_ADMIN_KEY"

# Обновить API ключ
curl --request POST "https://api.anthropic.com/v1/organizations/api_keys/{api_key_id}" \
  --header "anthropic-version: 2023-06-01" \
  --header "x-api-key: $ANTHROPIC_ADMIN_KEY" \
  --data '{
    "status": "inactive",
    "name": "New Key Name"
  }'

Доступ к информации об организации

Получите информацию о вашей организации программно с помощью эндпоинта /v1/organizations/me.

Например:

curl "https://api.anthropic.com/v1/organizations/me" \
  --header "anthropic-version: 2023-06-01" \
  --header "x-api-key: $ADMIN_API_KEY"

{
  "id": "12345678-1234-5678-1234-567812345678",
  "type": "organization",
  "name": "Organization Name"
}

Этот эндпоинт полезен для программного определения того, к какой организации принадлежит Admin API ключ.

Для полных деталей параметров и схем ответов см. справочник API информации об организации.

Доступ к отчетам об использовании и стоимости

Для доступа к отчетам об использовании и стоимости для вашей организации используйте эндпоинты API использования и стоимости:

Эндпоинт использования (/v1/organizations/usage_report/messages) предоставляет подробные данные об использовании, включая количество токенов и метрики запросов, сгруппированные по различным измерениям, таким как рабочее пространство, пользователь и модель.
Эндпоинт стоимости (/v1/organizations/cost_report) предоставляет данные о стоимости, связанные с использованием вашей организации, позволяя отслеживать расходы и распределять затраты по рабочим пространствам или описанию.

Эти эндпоинты предоставляют подробную информацию об использовании вашей организации и связанных с ним затратах.

Доступ к аналитике Claude Code

Для организаций, использующих Claude Code, API аналитики Claude Code предоставляет подробные метрики производительности и аналитику использования:

Эндпоинт аналитики Claude Code (/v1/organizations/usage_report/claude_code) предоставляет ежедневные агрегированные метрики для использования Claude Code, включая сессии, строки кода, коммиты, pull request'ы, статистику использования инструментов и данные о стоимости, разбитые по пользователям и моделям.

Этот API позволяет отслеживать производительность разработчиков, анализировать принятие Claude Code и создавать пользовательские панели мониторинга для вашей организации.

Лучшие практики

Для эффективного использования Admin API:

Используйте осмысленные имена и описания для рабочих пространств и API ключей
Реализуйте правильную обработку ошибок для неудачных операций
Регулярно проводите аудит ролей и разрешений участников
Очищайте неиспользуемые рабочие пространства и просроченные приглашения
Мониторьте использование API ключей и периодически ротируйте ключи

FAQ

Администрирование и мониторинг

Обзор Admin API

The Admin API is unavailable for individual accounts. To collaborate with teammates and add members, set up your organization in Console → Settings → Organization.

Admin API требует специального доступа

Как работает Admin API

Когда вы используете Admin API:

Вы делаете запросы, используя ваш Admin API ключ в заголовке x-api-key
API позволяет вам управлять:
- Участниками организации и их ролями
- Приглашениями участников организации
- Рабочими пространствами и их участниками
- API ключами

Это полезно для:

Автоматизации подключения/отключения пользователей
Программного управления доступом к рабочим пространствам
Мониторинга и управления использованием API ключей

Роли и разрешения организации

Существует пять ролей уровня организации. Подробнее см. здесь.

Роль	Разрешения
user	Может использовать Workbench
claude_code_user	Может использовать Workbench и Claude Code
developer	Может использовать Workbench и управлять API ключами
billing	Может использовать Workbench и управлять деталями биллинга
admin	Может делать все вышеперечисленное, плюс управлять пользователями

Ключевые концепции

Участники организации

Вы можете просматривать участников организации, обновлять роли участников и удалять участников.

Shell

# Список участников организации
curl "https://api.anthropic.com/v1/organizations/users?limit=10" \
  --header "anthropic-version: 2023-06-01" \
  --header "x-api-key: $ANTHROPIC_ADMIN_KEY"

# Обновить роль участника
curl "https://api.anthropic.com/v1/organizations/users/{user_id}" \
  --header "anthropic-version: 2023-06-01" \
  --header "x-api-key: $ANTHROPIC_ADMIN_KEY" \
  --data '{"role": "developer"}'

# Удалить участника
curl --request DELETE "https://api.anthropic.com/v1/organizations/users/{user_id}" \
  --header "anthropic-version: 2023-06-01" \
  --header "x-api-key: $ANTHROPIC_ADMIN_KEY"

Приглашения организации

Вы можете приглашать пользователей в организации и управлять этими приглашениями.

# Создать приглашение
curl --request POST "https://api.anthropic.com/v1/organizations/invites" \
  --header "anthropic-version: 2023-06-01" \
  --header "x-api-key: $ANTHROPIC_ADMIN_KEY" \
  --data '{
    "email": "[email protected]",
    "role": "developer"
  }'

# Список приглашений
curl "https://api.anthropic.com/v1/organizations/invites?limit=10" \
  --header "anthropic-version: 2023-06-01" \
  --header "x-api-key: $ANTHROPIC_ADMIN_KEY"

# Удалить приглашение
curl --request DELETE "https://api.anthropic.com/v1/organizations/invites/{invite_id}" \
  --header "anthropic-version: 2023-06-01" \
  --header "x-api-key: $ANTHROPIC_ADMIN_KEY"

Рабочие пространства

Создавайте и управляйте рабочими пространствами (консоль) для организации ваших ресурсов:

# Создать рабочее пространство
curl --request POST "https://api.anthropic.com/v1/organizations/workspaces" \
  --header "anthropic-version: 2023-06-01" \
  --header "x-api-key: $ANTHROPIC_ADMIN_KEY" \
  --data '{"name": "Production"}'

# Список рабочих пространств
curl "https://api.anthropic.com/v1/organizations/workspaces?limit=10&include_archived=false" \
  --header "anthropic-version: 2023-06-01" \
  --header "x-api-key: $ANTHROPIC_ADMIN_KEY"

# Архивировать рабочее пространство
curl --request POST "https://api.anthropic.com/v1/organizations/workspaces/{workspace_id}/archive" \
  --header "anthropic-version: 2023-06-01" \
  --header "x-api-key: $ANTHROPIC_ADMIN_KEY"

Участники рабочих пространств

Управляйте доступом пользователей к конкретным рабочим пространствам:

# Добавить участника в рабочее пространство
curl --request POST "https://api.anthropic.com/v1/organizations/workspaces/{workspace_id}/members" \
  --header "anthropic-version: 2023-06-01" \
  --header "x-api-key: $ANTHROPIC_ADMIN_KEY" \
  --data '{
    "user_id": "user_xxx",
    "workspace_role": "workspace_developer"
  }'

# Список участников рабочего пространства
curl "https://api.anthropic.com/v1/organizations/workspaces/{workspace_id}/members?limit=10" \
  --header "anthropic-version: 2023-06-01" \
  --header "x-api-key: $ANTHROPIC_ADMIN_KEY"

# Обновить роль участника
curl --request POST "https://api.anthropic.com/v1/organizations/workspaces/{workspace_id}/members/{user_id}" \
  --header "anthropic-version: 2023-06-01" \
  --header "x-api-key: $ANTHROPIC_ADMIN_KEY" \
  --data '{
    "workspace_role": "workspace_admin"
  }'

# Удалить участника из рабочего пространства
curl --request DELETE "https://api.anthropic.com/v1/organizations/workspaces/{workspace_id}/members/{user_id}" \
  --header "anthropic-version: 2023-06-01" \
  --header "x-api-key: $ANTHROPIC_ADMIN_KEY"

API ключи

Мониторинг и управление API ключами:

# Список API ключей
curl "https://api.anthropic.com/v1/organizations/api_keys?limit=10&status=active&workspace_id=wrkspc_xxx" \
  --header "anthropic-version: 2023-06-01" \
  --header "x-api-key: $ANTHROPIC_ADMIN_KEY"

# Обновить API ключ
curl --request POST "https://api.anthropic.com/v1/organizations/api_keys/{api_key_id}" \
  --header "anthropic-version: 2023-06-01" \
  --header "x-api-key: $ANTHROPIC_ADMIN_KEY" \
  --data '{
    "status": "inactive",
    "name": "New Key Name"
  }'

Доступ к информации об организации

Получите информацию о вашей организации программно с помощью эндпоинта /v1/organizations/me.

Например:

curl "https://api.anthropic.com/v1/organizations/me" \
  --header "anthropic-version: 2023-06-01" \
  --header "x-api-key: $ADMIN_API_KEY"

{
  "id": "12345678-1234-5678-1234-567812345678",
  "type": "organization",
  "name": "Organization Name"
}

Этот эндпоинт полезен для программного определения того, к какой организации принадлежит Admin API ключ.

Для полных деталей параметров и схем ответов см. справочник API информации об организации.

Доступ к отчетам об использовании и стоимости

Эндпоинт использования (/v1/organizations/usage_report/messages) предоставляет подробные данные об использовании, включая количество токенов и метрики запросов, сгруппированные по различным измерениям, таким как рабочее пространство, пользователь и модель.
Эндпоинт стоимости (/v1/organizations/cost_report) предоставляет данные о стоимости, связанные с использованием вашей организации, позволяя отслеживать расходы и распределять затраты по рабочим пространствам или описанию.

Доступ к аналитике Claude Code

Эндпоинт аналитики Claude Code (/v1/organizations/usage_report/claude_code) предоставляет ежедневные агрегированные метрики для использования Claude Code, включая сессии, строки кода, коммиты, pull request'ы, статистику использования инструментов и данные о стоимости, разбитые по пользователям и моделям.

Лучшие практики

Для эффективного использования Admin API:

Используйте осмысленные имена и описания для рабочих пространств и API ключей
Реализуйте правильную обработку ошибок для неудачных операций
Регулярно проводите аудит ролей и разрешений участников
Очищайте неиспользуемые рабочие пространства и просроченные приглашения
Мониторьте использование API ключей и периодически ротируйте ключи

Как работает Admin API

Роли и разрешения организации

Ключевые концепции

Участники организации

Приглашения организации

Рабочие пространства

Участники рабочих пространств

API ключи

Доступ к информации об организации

Доступ к отчетам об использовании и стоимости

Доступ к аналитике Claude Code

Лучшие практики

FAQ

Какие разрешения необходимы для использования Admin API?

Могу ли я создавать новые API ключи через Admin API?

Что происходит с API ключами при удалении пользователя?

Могут ли администраторы организации быть удалены через API?

Как долго действуют приглашения в организацию?

Есть ли ограничения на рабочие пространства?

Что такое рабочее пространство по умолчанию?

Как роли организации влияют на доступ к рабочим пространствам?

Какие роли могут быть назначены в рабочих пространствах?

Можно ли изменить роли в рабочих пространствах у администраторов или участников биллинга организации?

Что происходит с доступом к рабочим пространствам при изменении ролей в организации?

Как работает Admin API

Роли и разрешения организации

Ключевые концепции

Участники организации

Приглашения организации

Рабочие пространства

Участники рабочих пространств

API ключи

Доступ к информации об организации

Доступ к отчетам об использовании и стоимости

Доступ к аналитике Claude Code

Лучшие практики

FAQ

Какие разрешения необходимы для использования Admin API?

Могу ли я создавать новые API ключи через Admin API?

Что происходит с API ключами при удалении пользователя?

Могут ли администраторы организации быть удалены через API?

Как долго действуют приглашения в организацию?

Есть ли ограничения на рабочие пространства?

Что такое рабочее пространство по умолчанию?

Как роли организации влияют на доступ к рабочим пространствам?

Какие роли могут быть назначены в рабочих пространствах?

Можно ли изменить роли в рабочих пространствах у администраторов или участников биллинга организации?

Что происходит с доступом к рабочим пространствам при изменении ролей в организации?