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

Обзор Admin API

Управляйте ресурсами вашей организации программным способом с помощью 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"

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

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

Shell

# Создать приглашение
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"

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

Для полного руководства по рабочим пространствам см. Рабочие пространства.

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

Shell

# Создать рабочее пространство
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"

Члены рабочего пространства

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

Shell

# Добавить члена в рабочее пространство
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:

Shell

# Перечислить ключи 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, включая сеансы, строки кода, коммиты, запросы на слияние, статистику использования инструментов и данные о затратах, разбитые по пользователям и моделям.

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

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

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

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

Часто задаваемые вопросы

Was this page helpful?

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

Обзор 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"

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

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

Shell

# Создать приглашение
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"

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

Для полного руководства по рабочим пространствам см. Рабочие пространства.

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

Shell

# Создать рабочее пространство
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"

Члены рабочего пространства

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

Shell

# Добавить члена в рабочее пространство
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:

Shell

# Перечислить ключи 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, включая сеансы, строки кода, коммиты, запросы на слияние, статистику использования инструментов и данные о затратах, разбитые по пользователям и моделям.

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

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

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

Часто задаваемые вопросы

Was this page helpful?

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

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

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

Члены организации

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

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

Члены рабочего пространства

Ключи API

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

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

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

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

Часто задаваемые вопросы

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

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

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

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

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

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

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

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

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

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

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

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

Члены организации

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

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

Члены рабочего пространства

Ключи API

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

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

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

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

Часто задаваемые вопросы

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

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

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

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

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

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

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

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

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

Можно ли изменить роли рабочего пространства администраторов или членов организации, отвечающих за выставление счетов?

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