Claude Platform Docs

Организация

Получить текущую организацию
$ ant organization retrieve
GET/v1/organizations/me

Возвращает информацию об организации, связанной с аутентифицированным ключом API.

Models
organization_info: object{ type: "organization", id, name }
type: "organization"

Object type.

For Organizations, this is always "organization".

id: string

ID of the Organization.

formatuuid
name: string

Name of the Organization.

organization_role: "admin" or "billing" or "claude_code_user" or 6 more
"admin"
"billing"
"claude_code_user"
"developer"
"managed"
"membership_admin"
"owner"
"primary_owner"
"user"

ОрганизацияКлючи API

Список ключей API
$ ant organization:api-keys list
GET/v1/organizations/api_keys
Получить ключ API (Admin API)
$ ant organization:api-keys retrieve
GET/v1/organizations/api_keys/{api_key_id}

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

Обновить ключ API
$ ant organization:api-keys update
POST/v1/organizations/api_keys/{api_key_id}

ОрганизацияВнешние ключи

Создать внешний ключ
$ ant organization:external-keys create
POST/v1/organizations/external_keys

Создаёт конфигурацию внешнего ключа, принадлежащую организации вызывающей стороны.

Список внешних ключей
$ ant organization:external-keys list
GET/v1/organizations/external_keys

Возвращает список конфигураций внешних ключей в организации вызывающей стороны.

Получить внешний ключ
$ ant organization:external-keys retrieve
GET/v1/organizations/external_keys/{external_key_id}

Возвращает одну конфигурацию внешнего ключа в организации вызывающей стороны по идентификатору.

Обновить внешний ключ
$ ant organization:external-keys update
POST/v1/organizations/external_keys/{external_key_id}

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

Удалить внешний ключ
$ ant organization:external-keys delete
DELETE/v1/organizations/external_keys/{external_key_id}

Удаляет конфигурацию внешнего ключа.

Проверить внешний ключ
$ ant organization:external-keys validate
POST/v1/organizations/external_keys/{external_key_id}/validate

Проверяет конфигурацию внешнего ключа в KMS клиента.

ОрганизацияФедерацияИздатели

Создать издателя федерации
$ ant organization:federation:issuers create
POST/v1/organizations/federation_issuers

Требуется токен доступа OAuth с областью org:admin, полученный с помощью ant auth login --scope org:admin или правила федерации удостоверений рабочих нагрузок; ключи Admin API не принимаются. См. Управление WIF с помощью Admin API.

Список издателей федерации
$ ant organization:federation:issuers list
GET/v1/organizations/federation_issuers

Требуется токен доступа OAuth с областью org:admin, полученный с помощью ant auth login --scope org:admin или правила федерации удостоверений рабочих нагрузок; ключи Admin API не принимаются. См. Управление WIF с помощью Admin API.

Получить издателя федерации
$ ant organization:federation:issuers retrieve
GET/v1/organizations/federation_issuers/{federation_issuer_id}

Требуется токен доступа OAuth с областью org:admin, полученный с помощью ant auth login --scope org:admin или правила федерации удостоверений рабочих нагрузок; ключи Admin API не принимаются. См. Управление WIF с помощью Admin API.

Обновить издателя федерации
$ ant organization:federation:issuers update
POST/v1/organizations/federation_issuers/{federation_issuer_id}

Требуется токен доступа OAuth с областью org:admin, полученный с помощью ant auth login --scope org:admin или правила федерации удостоверений рабочих нагрузок; ключи Admin API не принимаются. См. Управление WIF с помощью Admin API.

Архивировать издателя федерации
$ ant organization:federation:issuers archive
POST/v1/organizations/federation_issuers/{federation_issuer_id}/archive

Требуется токен доступа OAuth с областью org:admin, полученный с помощью ant auth login --scope org:admin или правила федерации удостоверений рабочих нагрузок; ключи Admin API не принимаются. См. Управление WIF с помощью Admin API.

ОрганизацияФедерацияПравила

Создать правило федерации
$ ant organization:federation:rules create
POST/v1/organizations/federation_rules

Требуется токен доступа OAuth с областью org:admin, полученный с помощью ant auth login --scope org:admin или правила федерации удостоверений рабочих нагрузок; ключи Admin API не принимаются. См. Управление WIF с помощью Admin API.

Список правил федерации
$ ant organization:federation:rules list
GET/v1/organizations/federation_rules

Требуется токен доступа OAuth с областью org:admin, полученный с помощью ant auth login --scope org:admin или правила федерации удостоверений рабочих нагрузок; ключи Admin API не принимаются. См. Управление WIF с помощью Admin API.

Получить правило федерации
$ ant organization:federation:rules retrieve
GET/v1/organizations/federation_rules/{federation_rule_id}

Требуется токен доступа OAuth с областью org:admin, полученный с помощью ant auth login --scope org:admin или правила федерации удостоверений рабочих нагрузок; ключи Admin API не принимаются. См. Управление WIF с помощью Admin API.

Обновить правило федерации
$ ant organization:federation:rules update
POST/v1/organizations/federation_rules/{federation_rule_id}

Требуется токен доступа OAuth с областью org:admin, полученный с помощью ant auth login --scope org:admin или правила федерации удостоверений рабочих нагрузок; ключи Admin API не принимаются. См. Управление WIF с помощью Admin API.

Архивировать правило федерации
$ ant organization:federation:rules archive
POST/v1/organizations/federation_rules/{federation_rule_id}/archive

Требуется токен доступа OAuth с областью org:admin, полученный с помощью ant auth login --scope org:admin или правила федерации удостоверений рабочих нагрузок; ключи Admin API не принимаются. См. Управление WIF с помощью Admin API.

ОрганизацияФедерацияПравилаРабочие пространства

Добавить рабочее пространство в правило федерации
$ ant organization:federation:rules:workspaces add
POST/v1/organizations/federation_rules/{federation_rule_id}/workspaces

Требуется токен доступа OAuth с областью org:admin, полученный с помощью ant auth login --scope org:admin или правила федерации удостоверений рабочих нагрузок; ключи Admin API не принимаются. См. Управление WIF с помощью Admin API.

Список рабочих пространств правила федерации
$ ant organization:federation:rules:workspaces list
GET/v1/organizations/federation_rules/{federation_rule_id}/workspaces

Требуется токен доступа OAuth с областью org:admin, полученный с помощью ant auth login --scope org:admin или правила федерации удостоверений рабочих нагрузок; ключи Admin API не принимаются. См. Управление WIF с помощью Admin API.

Удалить рабочее пространство из правила федерации
$ ant organization:federation:rules:workspaces remove
DELETE/v1/organizations/federation_rules/{federation_rule_id}/workspaces/{workspace_id}

Требуется токен доступа OAuth с областью org:admin, полученный с помощью ant auth login --scope org:admin или правила федерации удостоверений рабочих нагрузок; ключи Admin API не принимаются. См. Управление WIF с помощью Admin API.

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

Создать приглашение
$ ant organization:invites create
POST/v1/organizations/invites

Приглашает пользователя присоединиться к организации по электронной почте.

Список приглашений
$ ant organization:invites list
GET/v1/organizations/invites

Возвращает список приглашений организации.

Получить приглашение
$ ant organization:invites retrieve
GET/v1/organizations/invites/{invite_id}

Возвращает приглашение по идентификатору.

Удалить приглашение
$ ant organization:invites delete
DELETE/v1/organizations/invites/{invite_id}

Удаляет ожидающее приглашение.

ОрганизацияСервисные аккаунты

Создать сервисный аккаунт
$ ant organization:service-accounts create
POST/v1/organizations/service_accounts

Требуется токен доступа OAuth с областью org:admin, полученный с помощью ant auth login --scope org:admin или правила федерации удостоверений рабочих нагрузок; ключи Admin API не принимаются. См. Управление WIF с помощью Admin API.

Список сервисных аккаунтов
$ ant organization:service-accounts list
GET/v1/organizations/service_accounts

Требуется токен доступа OAuth с областью org:admin, полученный с помощью ant auth login --scope org:admin или правила федерации удостоверений рабочих нагрузок; ключи Admin API не принимаются. См. Управление WIF с помощью Admin API.

Получить сервисный аккаунт
$ ant organization:service-accounts retrieve
GET/v1/organizations/service_accounts/{service_account_id}

Требуется токен доступа OAuth с областью org:admin, полученный с помощью ant auth login --scope org:admin или правила федерации удостоверений рабочих нагрузок; ключи Admin API не принимаются. См. Управление WIF с помощью Admin API.

Обновить сервисный аккаунт
$ ant organization:service-accounts update
POST/v1/organizations/service_accounts/{service_account_id}

Требуется токен доступа OAuth с областью org:admin, полученный с помощью ant auth login --scope org:admin или правила федерации удостоверений рабочих нагрузок; ключи Admin API не принимаются. См. Управление WIF с помощью Admin API.

Архивировать сервисный аккаунт
$ ant organization:service-accounts archive
POST/v1/organizations/service_accounts/{service_account_id}/archive

Требуется токен доступа OAuth с областью org:admin, полученный с помощью ant auth login --scope org:admin или правила федерации удостоверений рабочих нагрузок; ключи Admin API не принимаются. См. Управление WIF с помощью Admin API.

ОрганизацияСервисные аккаунтыРабочие пространства

Добавить рабочее пространство в сервисный аккаунт
$ ant organization:service-accounts:workspaces add
POST/v1/organizations/service_accounts/{service_account_id}/workspaces

Требуется токен доступа OAuth с областью org:admin, полученный с помощью ant auth login --scope org:admin или правила федерации удостоверений рабочих нагрузок; ключи Admin API не принимаются. См. Управление WIF с помощью Admin API.

Список рабочих пространств сервисного аккаунта
$ ant organization:service-accounts:workspaces list
GET/v1/organizations/service_accounts/{service_account_id}/workspaces

Требуется токен доступа OAuth с областью org:admin, полученный с помощью ant auth login --scope org:admin или правила федерации удостоверений рабочих нагрузок; ключи Admin API не принимаются. См. Управление WIF с помощью Admin API.

Удалить рабочее пространство из сервисного аккаунта
$ ant organization:service-accounts:workspaces remove
DELETE/v1/organizations/service_accounts/{service_account_id}/workspaces/{workspace_id}

Требуется токен доступа OAuth с областью org:admin, полученный с помощью ant auth login --scope org:admin или правила федерации удостоверений рабочих нагрузок; ключи Admin API не принимаются. См. Управление WIF с помощью Admin API.

ОрганизацияПользователи

Список пользователей
$ ant organization:users list
GET/v1/organizations/users

Возвращает список участников организации.

Получить пользователя
$ ant organization:users retrieve
GET/v1/organizations/users/{user_id}

Возвращает участника организации по идентификатору пользователя.

Обновить пользователя
$ ant organization:users update
POST/v1/organizations/users/{user_id}

Обновляет роль участника в организации.

Удалить пользователя
$ ant organization:users remove
DELETE/v1/organizations/users/{user_id}

Удаляет участника из организации.

Список рабочих пространств
$ ant organization:workspaces list
GET/v1/organizations/workspaces
Создать рабочее пространство
$ ant organization:workspaces create
POST/v1/organizations/workspaces
Получить рабочее пространство
$ ant organization:workspaces retrieve
GET/v1/organizations/workspaces/{workspace_id}
Обновить рабочее пространство
$ ant organization:workspaces update
POST/v1/organizations/workspaces/{workspace_id}
Архивировать рабочее пространство
$ ant organization:workspaces archive
POST/v1/organizations/workspaces/{workspace_id}/archive

ОрганизацияРабочие пространстваОграничения скорости

Список ограничений скорости рабочего пространства
$ ant organization:workspaces:rate-limits list
GET/v1/organizations/workspaces/{workspace_id}/rate_limits

Возвращает список ограничений скорости рабочего пространства.

ОрганизацияРабочие пространстваУчастники

Список участников рабочего пространства
$ ant organization:workspaces:members list
GET/v1/organizations/workspaces/{workspace_id}/members
Создать участника рабочего пространства
$ ant organization:workspaces:members add
POST/v1/organizations/workspaces/{workspace_id}/members
Получить участника рабочего пространства
$ ant organization:workspaces:members retrieve
GET/v1/organizations/workspaces/{workspace_id}/members/{user_id}
Обновить участника рабочего пространства
$ ant organization:workspaces:members update
POST/v1/organizations/workspaces/{workspace_id}/members/{user_id}
Удалить участника рабочего пространства
$ ant organization:workspaces:members remove
DELETE/v1/organizations/workspaces/{workspace_id}/members/{user_id}

ОрганизацияРабочие пространстваСервисные аккаунты

Список сервисных аккаунтов — участников рабочего пространства
$ ant organization:workspaces:service-accounts list
GET/v1/organizations/workspaces/{workspace_id}/service_accounts

Требуется токен доступа OAuth с областью org:admin, полученный с помощью ant auth login --scope org:admin или правила федерации удостоверений рабочих нагрузок; ключи Admin API не принимаются. См. Управление WIF с помощью Admin API.

Добавить сервисный аккаунт в рабочее пространство
$ ant organization:workspaces:service-accounts add
POST/v1/organizations/workspaces/{workspace_id}/service_accounts

Требуется токен доступа OAuth с областью org:admin, полученный с помощью ant auth login --scope org:admin или правила федерации удостоверений рабочих нагрузок; ключи Admin API не принимаются. См. Управление WIF с помощью Admin API.

Получить членство сервисного аккаунта в рабочем пространстве
$ ant organization:workspaces:service-accounts retrieve
GET/v1/organizations/workspaces/{workspace_id}/service_accounts/{service_account_id}

Требуется токен доступа OAuth с областью org:admin, полученный с помощью ant auth login --scope org:admin или правила федерации удостоверений рабочих нагрузок; ключи Admin API не принимаются. См. Управление WIF с помощью Admin API.

Обновить членство сервисного аккаунта в рабочем пространстве
$ ant organization:workspaces:service-accounts update
POST/v1/organizations/workspaces/{workspace_id}/service_accounts/{service_account_id}

Требуется токен доступа OAuth с областью org:admin, полученный с помощью ant auth login --scope org:admin или правила федерации удостоверений рабочих нагрузок; ключи Admin API не принимаются. См. Управление WIF с помощью Admin API.

Удалить сервисный аккаунт из рабочего пространства
$ ant organization:workspaces:service-accounts remove
DELETE/v1/organizations/workspaces/{workspace_id}/service_accounts/{service_account_id}

Требуется токен доступа OAuth с областью org:admin, полученный с помощью ant auth login --scope org:admin или правила федерации удостоверений рабочих нагрузок; ключи Admin API не принимаются. См. Управление WIF с помощью Admin API.

Список ограничений скорости организации
$ ant organization:rate-limits list
GET/v1/organizations/rate_limits

Список ограничений скорости Messages API для вашей организации.

Получение настроек соответствия требованиям
$ ant organization:compliance-settings retrieve
GET/v1/organizations/compliance_settings

Получение настроек соответствия требованиям (Compliance Settings) вашей организации.

Обновление настроек соответствия требованиям
$ ant organization:compliance-settings update
POST/v1/organizations/compliance_settings

Обновление настроек соответствия требованиям (Compliance Settings) вашей организации.