Claude Platform Docs

Организация

Получить текущую организацию
BetaOrganization Beta.Organization.Retrieve(parameters, cancellationToken = default)
GET/v1/organizations/me

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

Models
class BetaOrganization { Type = "organization"; ID; Name; }
JsonElement Type = "organization"

Object type.

For Organizations, this is always "organization".

required string ID

ID of the Organization.

formatuuid
required string Name

Name of the Organization.

enum BetaOrganizationRole
Admin("admin")
Billing("billing")
ClaudeCodeUser("claude_code_user")
Developer("developer")
Managed("managed")
MembershipAdmin("membership_admin")
Owner("owner")
PrimaryOwner("primary_owner")
User("user")

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

Список ключей API
ApiKeyListPage Beta.Organization.ApiKeys.List(parameters, cancellationToken = default)
GET/v1/organizations/api_keys
Получить ключ API (Admin API)
BetaApiKey Beta.Organization.ApiKeys.Retrieve(parameters, cancellationToken = default)
GET/v1/organizations/api_keys/{api_key_id}

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

Обновить ключ API
BetaApiKey Beta.Organization.ApiKeys.Update(parameters, cancellationToken = default)
POST/v1/organizations/api_keys/{api_key_id}

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

Создать внешний ключ
BetaExternalKey Beta.Organization.ExternalKeys.Create(parameters, cancellationToken = default)
POST/v1/organizations/external_keys

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

Список внешних ключей
ExternalKeyListPage Beta.Organization.ExternalKeys.List(parameters, cancellationToken = default)
GET/v1/organizations/external_keys

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

Получить внешний ключ
BetaExternalKey Beta.Organization.ExternalKeys.Retrieve(parameters, cancellationToken = default)
GET/v1/organizations/external_keys/{external_key_id}

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

Обновить внешний ключ
BetaExternalKey Beta.Organization.ExternalKeys.Update(parameters, cancellationToken = default)
POST/v1/organizations/external_keys/{external_key_id}

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

Удалить внешний ключ
ExternalKeyDeleteResponse Beta.Organization.ExternalKeys.Delete(parameters, cancellationToken = default)
DELETE/v1/organizations/external_keys/{external_key_id}

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

Проверить внешний ключ
ExternalKeyValidateResponse Beta.Organization.ExternalKeys.Validate(parameters, cancellationToken = default)
POST/v1/organizations/external_keys/{external_key_id}/validate

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

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

Создать издателя федерации
BetaFederationIssuer Beta.Organization.Federation.Issuers.Create(parameters, cancellationToken = default)
POST/v1/organizations/federation_issuers

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

Список издателей федерации
IssuerListPage Beta.Organization.Federation.Issuers.List(parameters, cancellationToken = default)
GET/v1/organizations/federation_issuers

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

Получить издателя федерации
BetaFederationIssuer Beta.Organization.Federation.Issuers.Retrieve(parameters, cancellationToken = default)
GET/v1/organizations/federation_issuers/{federation_issuer_id}

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

Обновить издателя федерации
BetaFederationIssuer Beta.Organization.Federation.Issuers.Update(parameters, cancellationToken = default)
POST/v1/organizations/federation_issuers/{federation_issuer_id}

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

Архивировать издателя федерации
BetaFederationIssuer Beta.Organization.Federation.Issuers.Archive(parameters, cancellationToken = default)
POST/v1/organizations/federation_issuers/{federation_issuer_id}/archive

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

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

Создать правило федерации
BetaFederationRule Beta.Organization.Federation.Rules.Create(parameters, cancellationToken = default)
POST/v1/organizations/federation_rules

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

Список правил федерации
RuleListPage Beta.Organization.Federation.Rules.List(parameters, cancellationToken = default)
GET/v1/organizations/federation_rules

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

Получить правило федерации
BetaFederationRule Beta.Organization.Federation.Rules.Retrieve(parameters, cancellationToken = default)
GET/v1/organizations/federation_rules/{federation_rule_id}

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

Обновить правило федерации
BetaFederationRule Beta.Organization.Federation.Rules.Update(parameters, cancellationToken = default)
POST/v1/organizations/federation_rules/{federation_rule_id}

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

Архивировать правило федерации
BetaFederationRule Beta.Organization.Federation.Rules.Archive(parameters, cancellationToken = default)
POST/v1/organizations/federation_rules/{federation_rule_id}/archive

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

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

Добавить рабочее пространство правила федерации
BetaFederationRuleWorkspace Beta.Organization.Federation.Rules.Workspaces.Add(parameters, cancellationToken = default)
POST/v1/organizations/federation_rules/{federation_rule_id}/workspaces

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

Список рабочих пространств правила федерации
WorkspaceListPage Beta.Organization.Federation.Rules.Workspaces.List(parameters, cancellationToken = default)
GET/v1/organizations/federation_rules/{federation_rule_id}/workspaces

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

Удалить рабочее пространство правила федерации
WorkspaceRemoveResponse Beta.Organization.Federation.Rules.Workspaces.Remove(parameters, cancellationToken = default)
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.

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

Создать приглашение
BetaOrganizationInvite Beta.Organization.Invites.Create(parameters, cancellationToken = default)
POST/v1/organizations/invites

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

Список приглашений
InviteListPage Beta.Organization.Invites.List(parameters, cancellationToken = default)
GET/v1/organizations/invites

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

Получить приглашение
BetaOrganizationInvite Beta.Organization.Invites.Retrieve(parameters, cancellationToken = default)
GET/v1/organizations/invites/{invite_id}

Получить приглашение по идентификатору.

Удалить приглашение
InviteDeleteResponse Beta.Organization.Invites.Delete(parameters, cancellationToken = default)
DELETE/v1/organizations/invites/{invite_id}

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

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

Создать сервисный аккаунт
BetaServiceAccount Beta.Organization.ServiceAccounts.Create(parameters, cancellationToken = default)
POST/v1/organizations/service_accounts

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

Список сервисных аккаунтов
ServiceAccountListPage Beta.Organization.ServiceAccounts.List(parameters, cancellationToken = default)
GET/v1/organizations/service_accounts

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

Получить сервисный аккаунт
BetaServiceAccount Beta.Organization.ServiceAccounts.Retrieve(parameters, cancellationToken = default)
GET/v1/organizations/service_accounts/{service_account_id}

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

Обновить сервисный аккаунт
BetaServiceAccount Beta.Organization.ServiceAccounts.Update(parameters, cancellationToken = default)
POST/v1/organizations/service_accounts/{service_account_id}

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

Архивировать сервисный аккаунт
BetaServiceAccount Beta.Organization.ServiceAccounts.Archive(parameters, cancellationToken = default)
POST/v1/organizations/service_accounts/{service_account_id}/archive

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

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

Добавить рабочее пространство к сервисному аккаунту
BetaServiceAccountWorkspaceMember Beta.Organization.ServiceAccounts.Workspaces.Add(parameters, cancellationToken = default)
POST/v1/organizations/service_accounts/{service_account_id}/workspaces

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

Список рабочих пространств сервисного аккаунта
WorkspaceListPage Beta.Organization.ServiceAccounts.Workspaces.List(parameters, cancellationToken = default)
GET/v1/organizations/service_accounts/{service_account_id}/workspaces

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

Удалить рабочее пространство из сервисного аккаунта
WorkspaceRemoveResponse Beta.Organization.ServiceAccounts.Workspaces.Remove(parameters, cancellationToken = default)
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.

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

Список пользователей
UserListPage Beta.Organization.Users.List(parameters, cancellationToken = default)
GET/v1/organizations/users

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

Получить пользователя
BetaOrganizationUser Beta.Organization.Users.Retrieve(parameters, cancellationToken = default)
GET/v1/organizations/users/{user_id}

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

Обновить пользователя
BetaOrganizationUser Beta.Organization.Users.Update(parameters, cancellationToken = default)
POST/v1/organizations/users/{user_id}

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

Удалить пользователя
UserRemoveResponse Beta.Organization.Users.Remove(parameters, cancellationToken = default)
DELETE/v1/organizations/users/{user_id}

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

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

Список рабочих пространств
WorkspaceListPage Beta.Organization.Workspaces.List(parameters, cancellationToken = default)
GET/v1/organizations/workspaces
Создать рабочее пространство
BetaWorkspace Beta.Organization.Workspaces.Create(parameters, cancellationToken = default)
POST/v1/organizations/workspaces
Получить рабочее пространство
BetaWorkspace Beta.Organization.Workspaces.Retrieve(parameters, cancellationToken = default)
GET/v1/organizations/workspaces/{workspace_id}
Обновить рабочее пространство
BetaWorkspace Beta.Organization.Workspaces.Update(parameters, cancellationToken = default)
POST/v1/organizations/workspaces/{workspace_id}
Архивировать рабочее пространство
BetaWorkspace Beta.Organization.Workspaces.Archive(parameters, cancellationToken = default)
POST/v1/organizations/workspaces/{workspace_id}/archive

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

Список ограничений скорости рабочего пространства
RateLimitListPage Beta.Organization.Workspaces.RateLimits.List(parameters, cancellationToken = default)
GET/v1/organizations/workspaces/{workspace_id}/rate_limits

Вывести список переопределений ограничений скорости, настроенных для рабочего пространства.

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

Список участников рабочего пространства
MemberListPage Beta.Organization.Workspaces.Members.List(parameters, cancellationToken = default)
GET/v1/organizations/workspaces/{workspace_id}/members
Создать участника рабочего пространства
BetaWorkspaceMember Beta.Organization.Workspaces.Members.Add(parameters, cancellationToken = default)
POST/v1/organizations/workspaces/{workspace_id}/members
Получить участника рабочего пространства
BetaWorkspaceMember Beta.Organization.Workspaces.Members.Retrieve(parameters, cancellationToken = default)
GET/v1/organizations/workspaces/{workspace_id}/members/{user_id}
Обновить участника рабочего пространства
BetaWorkspaceMember Beta.Organization.Workspaces.Members.Update(parameters, cancellationToken = default)
POST/v1/organizations/workspaces/{workspace_id}/members/{user_id}
Удалить участника рабочего пространства
MemberRemoveResponse Beta.Organization.Workspaces.Members.Remove(parameters, cancellationToken = default)
DELETE/v1/organizations/workspaces/{workspace_id}/members/{user_id}

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

Список участников рабочего пространства — сервисных аккаунтов
ServiceAccountListPage Beta.Organization.Workspaces.ServiceAccounts.List(parameters, cancellationToken = default)
GET/v1/organizations/workspaces/{workspace_id}/service_accounts

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

Создать участника рабочего пространства — сервисный аккаунт
BetaServiceAccountWorkspaceMember Beta.Organization.Workspaces.ServiceAccounts.Add(parameters, cancellationToken = default)
POST/v1/organizations/workspaces/{workspace_id}/service_accounts

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

Получить участника рабочего пространства — сервисный аккаунт
BetaServiceAccountWorkspaceMember Beta.Organization.Workspaces.ServiceAccounts.Retrieve(parameters, cancellationToken = default)
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.

Обновить участника рабочего пространства — сервисный аккаунт
BetaServiceAccountWorkspaceMember Beta.Organization.Workspaces.ServiceAccounts.Update(parameters, cancellationToken = default)
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.

Удалить участника рабочего пространства — сервисный аккаунт
ServiceAccountRemoveResponse Beta.Organization.Workspaces.ServiceAccounts.Remove(parameters, cancellationToken = default)
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.

ОрганизацияОграничения скорости

Список ограничений скорости организации
RateLimitListPage Beta.Organization.RateLimits.List(parameters, cancellationToken = default)
GET/v1/organizations/rate_limits

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

ОрганизацияНастройки соответствия требованиям

Получение настроек соответствия требованиям
BetaComplianceSettings Beta.Organization.ComplianceSettings.Retrieve(parameters, cancellationToken = default)
GET/v1/organizations/compliance_settings

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

Обновление настроек соответствия требованиям
BetaComplianceSettings Beta.Organization.ComplianceSettings.Update(parameters, cancellationToken = default)
POST/v1/organizations/compliance_settings

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