Обзор Admin API

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

Обзор Admin API

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

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

Существует пять ролей на уровне организации. Дополнительные сведения см. в статье API Console roles and permissions.

Роль	Разрешения
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"

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

Для подробного руководства по рабочим пространствам, включая примеры Console и API, см. Workspaces.

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

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

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.

Для получения полных сведений о параметрах и схемах ответов см. Organization Info API reference.

Отчеты об использовании и затратах

Отслеживайте использование и затраты вашей организации с помощью Usage and Cost API.

Аналитика Claude Code

Мониторьте производительность разработчиков и внедрение Claude Code с помощью Claude Code Analytics API.

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

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

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

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

Для вопросов, связанных с рабочими пространствами, см. Workspaces FAQ.

Was this page helpful?

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

Обзор Admin API

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

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

Существует пять ролей на уровне организации. Дополнительные сведения см. в статье API Console roles and permissions.

Роль	Разрешения
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"

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

Для подробного руководства по рабочим пространствам, включая примеры Console и API, см. Workspaces.

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

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

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.

Для получения полных сведений о параметрах и схемах ответов см. Organization Info API reference.

Отчеты об использовании и затратах

Отслеживайте использование и затраты вашей организации с помощью Usage and Cost API.

Аналитика Claude Code

Мониторьте производительность разработчиков и внедрение Claude Code с помощью Claude Code Analytics API.

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

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

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

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

Для вопросов, связанных с рабочими пространствами, см. Workspaces FAQ.

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?

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