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

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

Административный API требует специального доступа

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

​
Как работает Административный API

Когда вы используете Административный API:

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

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

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

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

Существует четыре роли на уровне организации.

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

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

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

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

# Список участников организации
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": "newuser@domain.com",
    "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"
  }'

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

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

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

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

Was this page helpful?

Надстройка Google SheetsУменьшение галлюцинаций