Claude Platform Docs

Организация

Получить текущую организацию
organization.retrieve() -> OrganizationInfo
GET/v1/organizations/me

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

Models
class OrganizationInfo: type: "organization"; id; name
type: Literal["organization"]

Object type.

For Organizations, this is always "organization".

defaultorganization
id: str

ID of the Organization.

formatuuid
name: str

Name of the Organization.

type OrganizationRole = Literal["admin", "billing", "claude_code_user", 6 more]
One of the following:
"admin"
"billing"
"claude_code_user"
"developer"
"managed"
"membership_admin"
"owner"
"primary_owner"
"user"

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

Список ключей API
organization.api_keys.list(**kwargs) -> SyncPage[APIKey]
GET/v1/organizations/api_keys
Получить ключ API (Admin API)
organization.api_keys.retrieve(api_key_id) -> APIKey
GET/v1/organizations/api_keys/{api_key_id}

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

Обновить ключ API
organization.api_keys.update(api_key_id, **kwargs) -> APIKey
POST/v1/organizations/api_keys/{api_key_id}

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

Создать внешний ключ
organization.external_keys.create(**kwargs) -> ExternalKey
POST/v1/organizations/external_keys

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

Список внешних ключей
organization.external_keys.list(**kwargs) -> SyncPageCursor[ExternalKey]
GET/v1/organizations/external_keys

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

Получить внешний ключ
organization.external_keys.retrieve(external_key_id) -> ExternalKey
GET/v1/organizations/external_keys/{external_key_id}

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

Обновить внешний ключ
organization.external_keys.update(external_key_id, **kwargs) -> ExternalKey
POST/v1/organizations/external_keys/{external_key_id}

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

Удалить внешний ключ
organization.external_keys.delete(external_key_id) -> ExternalKeyDeleteResponse
DELETE/v1/organizations/external_keys/{external_key_id}

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

Проверить внешний ключ
organization.external_keys.validate(external_key_id) -> ExternalKeyValidateResponse
POST/v1/organizations/external_keys/{external_key_id}/validate

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

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

Создать издателя федерации
organization.federation.issuers.create(**kwargs) -> FederationIssuer
POST/v1/organizations/federation_issuers

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

Список издателей федерации
organization.federation.issuers.list(**kwargs) -> SyncPageCursor[FederationIssuer]
GET/v1/organizations/federation_issuers

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

Получить издателя федерации
organization.federation.issuers.retrieve(federation_issuer_id) -> FederationIssuer
GET/v1/organizations/federation_issuers/{federation_issuer_id}

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

Обновить издателя федерации
organization.federation.issuers.update(federation_issuer_id, **kwargs) -> FederationIssuer
POST/v1/organizations/federation_issuers/{federation_issuer_id}

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

Архивировать издателя федерации
organization.federation.issuers.archive(federation_issuer_id) -> FederationIssuer
POST/v1/organizations/federation_issuers/{federation_issuer_id}/archive

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

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

Создать правило федерации
organization.federation.rules.create(**kwargs) -> FederationRule
POST/v1/organizations/federation_rules

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

Список правил федерации
organization.federation.rules.list(**kwargs) -> SyncPageCursor[FederationRule]
GET/v1/organizations/federation_rules

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

Получить правило федерации
organization.federation.rules.retrieve(federation_rule_id) -> FederationRule
GET/v1/organizations/federation_rules/{federation_rule_id}

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

Обновить правило федерации
organization.federation.rules.update(federation_rule_id, **kwargs) -> FederationRule
POST/v1/organizations/federation_rules/{federation_rule_id}

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

Архивировать правило федерации
organization.federation.rules.archive(federation_rule_id) -> FederationRule
POST/v1/organizations/federation_rules/{federation_rule_id}/archive

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

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

Добавить рабочее пространство в правило федерации
organization.federation.rules.workspaces.add(federation_rule_id, **kwargs) -> FederationRuleWorkspace
POST/v1/organizations/federation_rules/{federation_rule_id}/workspaces

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

Список рабочих пространств правила федерации
organization.federation.rules.workspaces.list(federation_rule_id, **kwargs) -> SyncPageCursor[FederationRuleWorkspace]
GET/v1/organizations/federation_rules/{federation_rule_id}/workspaces

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

Удалить рабочее пространство из правила федерации
organization.federation.rules.workspaces.remove(workspace_id, **kwargs) -> WorkspaceRemoveResponse
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.

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

Создать приглашение
organization.invites.create(**kwargs) -> OrganizationInvite
POST/v1/organizations/invites

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

Список приглашений
organization.invites.list(**kwargs) -> SyncPage[OrganizationInvite]
GET/v1/organizations/invites

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

Получить приглашение
organization.invites.retrieve(invite_id) -> OrganizationInvite
GET/v1/organizations/invites/{invite_id}

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

Удалить приглашение
organization.invites.delete(invite_id) -> InviteDeleteResponse
DELETE/v1/organizations/invites/{invite_id}

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

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

Создать сервисный аккаунт
organization.service_accounts.create(**kwargs) -> ServiceAccount
POST/v1/organizations/service_accounts

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

Список сервисных аккаунтов
organization.service_accounts.list(**kwargs) -> SyncPageCursor[ServiceAccount]
GET/v1/organizations/service_accounts

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

Получить сервисный аккаунт
organization.service_accounts.retrieve(service_account_id) -> ServiceAccount
GET/v1/organizations/service_accounts/{service_account_id}

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

Обновить сервисный аккаунт
organization.service_accounts.update(service_account_id, **kwargs) -> ServiceAccount
POST/v1/organizations/service_accounts/{service_account_id}

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

Архивировать сервисный аккаунт
organization.service_accounts.archive(service_account_id) -> ServiceAccount
POST/v1/organizations/service_accounts/{service_account_id}/archive

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

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

Добавить рабочее пространство в сервисный аккаунт
organization.service_accounts.workspaces.add(service_account_id, **kwargs) -> ServiceAccountWorkspaceMember
POST/v1/organizations/service_accounts/{service_account_id}/workspaces

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

Список рабочих пространств сервисного аккаунта
organization.service_accounts.workspaces.list(service_account_id, **kwargs) -> SyncPageCursor[ServiceAccountWorkspaceMember]
GET/v1/organizations/service_accounts/{service_account_id}/workspaces

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

Удалить рабочее пространство из сервисного аккаунта
organization.service_accounts.workspaces.remove(workspace_id, **kwargs) -> WorkspaceRemoveResponse
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.

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

Список пользователей
organization.users.list(**kwargs) -> SyncPage[OrganizationUser]
GET/v1/organizations/users

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

Получить пользователя
organization.users.retrieve(user_id) -> OrganizationUser
GET/v1/organizations/users/{user_id}

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

Обновить пользователя
organization.users.update(user_id, **kwargs) -> OrganizationUser
POST/v1/organizations/users/{user_id}

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

Удалить пользователя
organization.users.remove(user_id) -> UserRemoveResponse
DELETE/v1/organizations/users/{user_id}

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

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

Список рабочих пространств
organization.workspaces.list(**kwargs) -> SyncPage[Workspace]
GET/v1/organizations/workspaces
Создать рабочее пространство
organization.workspaces.create(**kwargs) -> Workspace
POST/v1/organizations/workspaces
Получить рабочее пространство
organization.workspaces.retrieve(workspace_id) -> Workspace
GET/v1/organizations/workspaces/{workspace_id}
Обновить рабочее пространство
organization.workspaces.update(workspace_id, **kwargs) -> Workspace
POST/v1/organizations/workspaces/{workspace_id}
Архивировать рабочее пространство
organization.workspaces.archive(workspace_id) -> Workspace
POST/v1/organizations/workspaces/{workspace_id}/archive

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

Список ограничений скорости рабочего пространства
organization.workspaces.rate_limits.list(workspace_id, **kwargs) -> SyncPageCursor[WorkspaceRateLimit]
GET/v1/organizations/workspaces/{workspace_id}/rate_limits

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

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

Список участников рабочего пространства
organization.workspaces.members.list(workspace_id, **kwargs) -> SyncPage[WorkspaceMember]
GET/v1/organizations/workspaces/{workspace_id}/members
Создать участника рабочего пространства
organization.workspaces.members.add(workspace_id, **kwargs) -> WorkspaceMember
POST/v1/organizations/workspaces/{workspace_id}/members
Получить участника рабочего пространства
organization.workspaces.members.retrieve(user_id, **kwargs) -> WorkspaceMember
GET/v1/organizations/workspaces/{workspace_id}/members/{user_id}
Обновить участника рабочего пространства
organization.workspaces.members.update(user_id, **kwargs) -> WorkspaceMember
POST/v1/organizations/workspaces/{workspace_id}/members/{user_id}
Удалить участника рабочего пространства
organization.workspaces.members.remove(user_id, **kwargs) -> MemberRemoveResponse
DELETE/v1/organizations/workspaces/{workspace_id}/members/{user_id}

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

Список сервисных аккаунтов — участников рабочего пространства
organization.workspaces.service_accounts.list(workspace_id, **kwargs) -> SyncPageCursor[ServiceAccountWorkspaceMember]
GET/v1/organizations/workspaces/{workspace_id}/service_accounts

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

Добавить сервисный аккаунт в рабочее пространство
organization.workspaces.service_accounts.add(workspace_id, **kwargs) -> ServiceAccountWorkspaceMember
POST/v1/organizations/workspaces/{workspace_id}/service_accounts

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

Получить членство сервисного аккаунта в рабочем пространстве
organization.workspaces.service_accounts.retrieve(service_account_id, **kwargs) -> ServiceAccountWorkspaceMember
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.

Обновить членство сервисного аккаунта в рабочем пространстве
organization.workspaces.service_accounts.update(service_account_id, **kwargs) -> ServiceAccountWorkspaceMember
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.

Удалить сервисный аккаунт из рабочего пространства
organization.workspaces.service_accounts.remove(service_account_id, **kwargs) -> ServiceAccountRemoveResponse
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.

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

Список ограничений скорости организации
organization.rate_limits.list(**kwargs) -> SyncPageCursor[OrganizationRateLimit]
GET/v1/organizations/rate_limits

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

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

Получение настроек соответствия требованиям
organization.compliance_settings.retrieve() -> OrganizationComplianceSettings
GET/v1/organizations/compliance_settings

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

Обновление настроек соответствия требованиям
organization.compliance_settings.update(**kwargs) -> OrganizationComplianceSettings
POST/v1/organizations/compliance_settings

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