Claude Platform Docs

Список организаций, пользователей, ролей, групп и настроек

Перечисляйте организации в составе вашей родительской организации (их пользователей, роли и группы) и считывайте действующие настройки каждой организации через Compliance API.

Конечные точки на этой странице предоставляют доступ к каталоговой стороне организации Claude Enterprise: её связанным организациям, пользователям в каждой из них, ролям, определённым в каждой, а также её группам на основе «role-based access control» (управление доступом на основе ролей), или RBAC, либо группам, созданным через «System for Cross-domain Identity Management» (система междоменного управления идентификацией), или SCIM, и их участникам. Используйте их для формирования списков пользователей для eDiscovery, построения отчётных панелей и сверки членства в группах с внешней системой учёта. Ключ Compliance Access Key, охватывающий родительскую организацию, возвращает данные из каждой связанной организации под ней, поэтому один ключ покрывает всё дерево. Конечная точка действующих настроек дополняет каталог: она возвращает настройки конфиденциальности данных, безопасности и возможностей, фактически действующие для одной организации.

Список организаций

Конечная точка List organizations возвращает каждую организацию в составе родительской организации, к которой привязан ключ.

Следующий вызов перечисляет все организации в составе вашей родительской. Ответ представляет собой массив data записей организаций, отсортированных по created_at по возрастанию, а также has_more и next_page для пагинации. Когда has_more равно true, передайте возвращённый токен next_page без изменений в качестве параметра запроса page в следующем запросе. Значения по умолчанию и диапазоны параметров limit и page см. в разделе List organizations справочника API.

cURL
curl --fail-with-body -sS \
  "https://api.anthropic.com/v1/compliance/organizations" \
  -H "x-api-key: $ANTHROPIC_COMPLIANCE_ACCESS_KEY"
Response
{
  "data": [
    {
      "uuid": "91012d09-e48b-438e-a489-1bebfd8fa6f9",
      "name": "Acme Engineering",
      "created_at": "2025-06-01T10:00:00Z"
    },
    {
      "uuid": "5a1b2c3d-4e5f-6789-abcd-ef0123456789",
      "name": "Acme Legal",
      "created_at": "2025-07-15T14:30:00Z"
    }
  ],
  "has_more": false,
  "next_page": null
}

Поле uuid — канонический идентификатор для последующих запросов. В следующей таблице оно сопоставлено с другими идентификаторами организаций в Compliance API:

ПолеГдеСвязь с uuid
{org_uuid}Параметр пути в конечных точках для отдельных организаций на этой страницеТо же значение
organization_uuidЗаписи Activity Feed, чатов, проектов и сессийТо же значение; соединяйте по этим двум полям напрямую
organization_idЗаписи Activity Feed, чатов и проектовТа же организация, с префиксом org_. Устарело в записях чатов и проектов; используйте вместо него organization_uuid.
organization_ids[]Фильтр в Запросе Activity Feed, Получении чатов и сообщений и списке удалённых сессий (в списке локальных сессий нет фильтра по организации)Принимает uuid или форму с префиксом org_
organization_idОтвет действующих настроек организацииТо же значение, «голый» UUID; этот ответ не использует форму с префиксом org_, которую organization_id имеет в записях Activity Feed, чатов и проектов

Большинство других API Anthropic используют форму с префиксом org_.

Чтобы отслеживать изменения членства организаций во времени, периодически повторно запрашивайте эту конечную точку, проходя по токену next_page через все страницы при каждом проходе. Activity Feed также отображает события членства через типы активности org_deletion_requested, org_deleted_via_bulk, org_parent_join_proposal_created и org_join_proposal_decided; см. Запрос Activity Feed.

Список пользователей организации

Конечная точка List organization users возвращает постраничный список записей пользователей для одной организации.

Эта конечная точка требует read:compliance_user_data, а не read:compliance_org_data. Создайте ключ Compliance Access Key с обеими областями доступа, если вы намерены использовать его для перечисления каталога; в противном случае вызов возвращает 403 Forbidden.

Значения по умолчанию и диапазоны параметров запроса limit и page см. в разделе List organization users справочника API.

Результаты отсортированы по дате вступления в организацию по возрастанию. В отличие от курсоров before_id/after_id в Activity Feed (см. Пагинация результатов), конечные точки каталога используют для пагинации токен next_page: когда has_more равно true, передайте next_page без изменений в качестве параметра запроса page в следующем запросе.

cURL
org_uuid="91012d09-e48b-438e-a489-1bebfd8fa6f9"

curl --fail-with-body -sS -G \
  "https://api.anthropic.com/v1/compliance/organizations/$org_uuid/users" \
  -H "x-api-key: $ANTHROPIC_COMPLIANCE_ACCESS_KEY" \
  --data-urlencode "limit=500"
Response
{
  "data": [
    {
      "id": "user_01XyDMpzjS89pFZXqSFUBDr6",
      "full_name": "Priya Sharma",
      "email": "priya@example.com",
      "organization_role": "admin",
      "created_at": "2025-06-01T10:00:00Z"
    }
  ],
  "has_more": true,
  "next_page": "page_8aW5kZXgicG9zaXRpb25fdG9rZW5fOTE0"
}

Возвращаемые здесь идентификаторы пользователей — это те же идентификаторы user_..., которые принимаются фильтром actor_ids[] в Запросе Activity Feed и фильтрами user_ids[] в Получении чатов и сообщений и списке удалённых сессий; в списке локальных сессий нет фильтра по пользователю, поэтому соотносите локальные сессии по user.id в каждом объекте сессии. Поле organization_role содержит встроенный уровень членства пользователя в указанной организации (одно из значений admin, billing, claude_code_user, developer, managed, membership_admin, owner, primary_owner или user) — ось, независимую от любых назначений пользовательских ролей RBAC, возвращаемых Списком ролей. Типичный процесс eDiscovery перечисляет пользователей одной или нескольких организаций, фильтрует их по вашим собственным внешним записям и передаёт полученные идентификаторы в запросы чатов и проектов.

Пользователь отображается здесь только пока он является активным участником организации. Удалённые пользователи исключаются из списка немедленно. Их историческая активность остаётся доступной для запросов через Activity Feed в течение всего окна хранения, индексированная по тому же идентификатору user_....

Список ролей

Конечная точка List Compliance Roles возвращает постраничный список записей ролей, определённых в одной организации, а Get Compliance Role возвращает одну роль по идентификатору.

Обе конечные точки ролей требуют read:compliance_org_data. Конечная точка списка принимает те же параметры limit и page, что и конечная точка пользователей организации.

cURL
org_uuid="91012d09-e48b-438e-a489-1bebfd8fa6f9"

curl --fail-with-body -sS \
  "https://api.anthropic.com/v1/compliance/organizations/${org_uuid}/roles" \
  -H "x-api-key: $ANTHROPIC_COMPLIANCE_ACCESS_KEY"
Response
{
  "data": [
    {
      "id": "rbac_role_01N2pQrS8tUvWxYz5AbCdEfGh",
      "name": "Compliance Reviewer",
      "description": "Read-only access to chat and project content for legal review.",
      "created_at": "2025-06-01T10:00:00Z",
      "updated_at": "2025-06-15T14:30:00Z"
    }
  ],
  "has_more": false,
  "next_page": null
}

Полную структуру записи роли см. в схеме ответа List Compliance Roles. Чтобы перечислить разрешения, в настоящее время предоставленные роли, используйте List Compliance Role Permissions. Для аудита исторических назначений ролей и изменений разрешений запрашивайте типы активности RBAC (например, rbac_role_assigned и rbac_role_permission_added) через Activity Feed; см. Фильтрация активностей.

Список групп и участников

Конечная точка List Compliance Groups возвращает постраничный список групп RBAC и групп, созданных через SCIM, а Get Compliance Group возвращает одну группу по идентификатору. Конечная точка List Compliance Group Members возвращает участников одной группы.

Конечные точки списка и получения групп требуют read:compliance_org_data. Конечная точка участников требует read:compliance_user_data. Создайте ключ с обеими областями доступа, чтобы обходить группы от начала до конца. Обе конечные точки списков принимают те же параметры limit и page, что и конечная точка пользователей организации.

Полную структуру записи группы см. в схеме ответа List Compliance Groups. Массив roles перечисляет идентификаторы ролей, назначенных группе, совпадающие с идентификаторами из Списка ролей. source_type — дискриминатор между группами, созданными вручную через claude.ai (direct), и группами, синхронизированными из внешнего поставщика удостоверений через SCIM (scim).

Перечислите группы, затем для каждой группы перечислите её участников:

cURL
curl --fail-with-body -sS -G \
  "https://api.anthropic.com/v1/compliance/groups" \
  -H "x-api-key: $ANTHROPIC_COMPLIANCE_ACCESS_KEY"
Response
{
  "data": [
    {
      "id": "rbac_group_01P9qRsTuVwXyZa2BcDeFgHjK",
      "name": "Engineering",
      "description": "Engineering team members",
      "source_type": "scim",
      "roles": ["rbac_role_01N2pQrS8tUvWxYz5AbCdEfGh"],
      "created_at": "2025-06-01T10:00:00Z",
      "updated_at": "2025-06-15T14:30:00Z"
    }
  ],
  "has_more": false,
  "next_page": null
}

Для каждого идентификатора группы перечислите её участников:

cURL
group_id="rbac_group_01P9qRsTuVwXyZa2BcDeFgHjK"

curl --fail-with-body -sS -G \
  "https://api.anthropic.com/v1/compliance/groups/$group_id/members" \
  -H "x-api-key: $ANTHROPIC_COMPLIANCE_ACCESS_KEY"
Response
{
  "data": [
    {
      "user_id": "user_01XyDMpzjS89pFZXqSFUBDr6",
      "email": "priya@example.com",
      "created_at": "2025-06-01T10:00:00Z",
      "updated_at": "2025-06-15T14:30:00Z"
    }
  ],
  "has_more": false,
  "next_page": null
}

Полную структуру записи участника см. в схеме ответа List Compliance Group Members. Поле user_id — это тот же идентификатор user_..., который принимают Activity Feed, список чатов и список удалённых сессий; он также совпадает с user.id в объектах локальных сессий и в объектах удалённых сессий, принадлежащих пользователям (удалённые сессии, принадлежащие агентам, вместо этого содержат идентификатор человека в started_by_user.id). Чтобы получить полное имя участника, найдите его через список пользователей организации.

Получение действующих настроек организации

Конечная точка Get effective organization settings возвращает настройки, действующие для одной организации в составе вашей родительской: принудительно применяемое состояние после применения регуляторных ограничений (таких как HIPAA), правил доступности функций, значений по умолчанию для типа организации и межфункциональных зависимостей, которое может отличаться от того, что настроил администратор. Используйте её, чтобы подтвердить, что окна хранения, редактирование содержимого, принудительное применение единого входа, список разрешённых IP-адресов и элементы управления длительностью сессий соответствуют вашему задокументированному базовому уровню, без административного доступа к Console.

Эта конечная точка требует read:compliance_org_data; ключ без этой области доступа возвращает 403 Forbidden. Целью должна быть одна из связанных организаций родительской: сама родительская организация не является допустимой целью. Неизвестная организация, идентификатор организации, не являющийся допустимым UUID, организация вне дерева вашей родительской и родительская организация, ещё не имеющая доступа к этой конечной точке, — все возвращают один и тот же 404 Not Found, поэтому 404 не раскрывает, существует ли организация. Конечная точка настроек включается для каждой родительской организации отдельно от остальной части Compliance API; если каждый запрос возвращает 404, обратитесь к вашему представителю Anthropic.

cURL
org_uuid="91012d09-e48b-438e-a489-1bebfd8fa6f9"

curl --fail-with-body -sS \
  "https://api.anthropic.com/v1/compliance/organizations/$org_uuid/settings" \
  -H "x-api-key: $ANTHROPIC_COMPLIANCE_ACCESS_KEY"

Ответ представляет собой список типизированных строк настроек, и набор присутствующих строк различается в зависимости от организации: настройка, которую администраторы организации не могут изменить, поскольку она контролируется политикой Anthropic или недоступна организации, исключается из списка. Рассматривайте отсутствующую строку как «не контролируется администраторами этой организации», а не как «выключено». Следующий сокращённый пример показывает три из строк, которые может содержать ответ:

Response
{
  "type": "effective_organization_settings",
  "organization_id": "91012d09-e48b-438e-a489-1bebfd8fa6f9",
  "settings": [
    {
      "name": "data_retention_periods",
      "type": "data_retention",
      "value": {
        "chat": {
          "type": "fixed",
          "timescale": "day",
          "duration": 90
        }
      }
    },
    {
      "name": "content_redaction_enabled",
      "type": "boolean",
      "value": true
    },
    {
      "name": "ip_allowlist_ip_ranges",
      "type": "string_list",
      "value": ["10.0.0.0/8", "203.0.113.0/24"]
    }
  ],
  "api_keys": [
    {
      "type": "compliance_api_key",
      "id": "apikey_01Hx7k2mP9nQ4rS6tU8vW0xY",
      "name": "Compliance Export Key",
      "scopes": ["read:compliance_activities", "read:compliance_org_data"],
      "is_active": true,
      "created_at": "2026-03-14T09:30:00Z",
      "created_by_id": "user_01Jz3a4bC5dE6fG7hI8jK9lM",
      "expires_at": null
    }
  ]
}

Каждая строка содержит name, type и value; поле type (boolean, integer, string_list, provisioning_mode или data_retention) указывает форму value. Полный список имён настроек и схема value для каждого типа приведены в разделе Get effective organization settings справочника API.

Массив api_keys перечисляет каждый ключ Compliance Access Key, настроенный для вашей родительской организации, поэтому один и тот же список возвращается независимо от того, какую связанную организацию вы запрашиваете. Каждая запись содержит type ключа (compliance_api_key), id, name, scopes, флаг is_active, временные метки created_at и expires_at, а также created_by_id (идентификатор пользователя, создавшего ключ; может быть null). Секретное значение ключа никогда не возвращается. Деактивированные ключи включаются с is_active: false, чтобы вы могли просмотреть ключи, ранее имевшие доступ, а ключи, имеющие только упразднённую область доступа read:compliance_org_settings, остаются в списке для целей аудита и очистки, хотя эта область доступа больше не предоставляет доступ.

organization_id верхнего уровня — это «голый» UUID организации: то же значение, что и uuid в списке организаций, а не форма с префиксом org_, которую organization_id имеет в записях Activity Feed, чатов и проектов (см. таблицу идентификаторов организаций).

Строки отражают принудительно применяемое состояние, а не последнюю сохранённую конфигурацию: например, sso_provisioning_mode сообщает настроенный режим SCIM только пока включена синхронизация каталога, ip_allowlist_enabled равно true только пока список разрешённых адресов включён и содержит хотя бы один активный диапазон, а code_execution_network_egress_enabled равно false всякий раз, когда выполнение кода выключено.

Ответ отражает состояние на момент чтения; никакие снимки не создаются. Изменения большинства этих настроек отображаются как события в Activity Feed; используйте эту конечную точку для получения текущего итогового состояния, а ленту — для аудита того, кто что изменил и когда.

Следующие шаги

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

Дословные полезные нагрузки ошибок и способ исправления каждой из них.

Was this page helpful?