Repository Public
1---2title: Organizations3url: https://platform.claude.com/docs/en/api/compliance/organizations4---56# Organizations78## List organizations910**GET** `/v1/compliance/organizations`1112List organizations under the parent organization.1314Returns organizations sorted by creation date in ascending order. Use15`limit` and `page` to paginate: each response includes `has_more` and a16`next_page` token to pass on the next request.1718### Query parameters1920- `limit: optional number`2122 Maximum results (default: 1000, max: 1000)2324 default: 1000, maximum: 1000, minimum: 12526- `page: optional string`2728 Opaque pagination token from a previous response's `next_page` field. Pass this to retrieve the next page of results. Clients should treat this value as an opaque string and not attempt to parse or interpret its contents, as the format may change without notice.2930### Headers3132- `"x-api-key": optional string`3334### Returns3536- `data: array of object`3738 List of organizations sorted by creation date, ascending3940 - `created_at: string`4142 Organization creation time (RFC 3339 format)4344 - `name: string`4546 Organization name4748 - `uuid: string`4950 Unique identifier for the organization (UUID format)5152- `has_more: boolean`5354 Whether more records exist beyond the current result set5556- `next_page: optional string or null`5758 Token to retrieve the next page. Use this as the 'page' parameter in your next request5960### Example6162```bash63curl https://api.anthropic.com/v1/compliance/organizations \64 -H 'anthropic-version: 2023-06-01' \65 -H "Authorization: Bearer $ANTHROPIC_COMPLIANCE_API_KEY"66```6768#### Response (200)6970```json71{72 "data": [73 {74 "created_at": "2025-03-12T18:22:41.123456+00:00",75 "name": "Acme Corp",76 "uuid": "a1b2c3d4-e5f6-4789-a012-3456789abcde"77 }78 ],79 "has_more": true,80 "next_page": "cGFnZV90b2tlbl9leGFtcGxlXzE3MzQ1Njc4OTA="81}82```8384## Domain types8586### Organization List Response8788- `OrganizationListResponse object`8990 Information about an organization.9192 - `created_at: string`9394 Organization creation time (RFC 3339 format)9596 - `name: string`9798 Organization name99100 - `uuid: string`101102 Unique identifier for the organization (UUID format)103104## Organizations › Users105106### List organization users107108**GET** `/v1/compliance/organizations/{org_uuid}/users`109110List current user members of an organization.111112#### Path parameters113114- `org_uuid: string`115116 The organization UUID117118#### Query parameters119120- `limit: optional number`121122 Maximum results (default: 500, max: 1000)123124 default: 500, maximum: 1000, minimum: 1125126- `page: optional string`127128 Opaque pagination token from a previous response's `next_page` field. Pass this to retrieve the next page of results. Clients should treat this value as an opaque string and not attempt to parse or interpret its contents, as the format may change without notice.129130#### Headers131132- `"x-api-key": optional string`133134#### Returns135136- `data: array of object`137138 List of current organization members sorted by organization join date ascending139140 - `id: string`141142 User identifier (tagged ID)143144 - `created_at: string`145146 User account creation timestamp147148 format: date-time149150 - `email: string`151152 User's current email address153154 - `full_name: string`155156 User's current full name157158 - `organization_role: "admin" or "billing" or "claude_code_user" or 8 more`159160 User's built-in role within the organization. This is distinct from any custom RBAC roles that may also be assigned.161162 - `"admin"`163164 - `"billing"`165166 - `"claude_code_user"`167168 - `"developer"`169170 - `"managed"`171172 - `"membership_admin"`173174 - `"owner"`175176 - `"parent_org_admin"`177178 - `"parent_org_owner"`179180 - `"primary_owner"`181182 - `"user"`183184- `has_more: boolean`185186 Whether more records exist beyond the current result set187188- `next_page: string or null`189190 Token to retrieve the next page. Use this as the 'page' parameter in your next request191192#### Example193194```bash195curl https://api.anthropic.com/v1/compliance/organizations/$ORG_UUID/users \196 -H 'anthropic-version: 2023-06-01' \197 -H "Authorization: Bearer $ANTHROPIC_COMPLIANCE_API_KEY"198```199200##### Response (200)201202```json203{204 "data": [205 {206 "id": "user_01WCz1FkmYMm4gnmykNKUu3Q",207 "created_at": "2025-03-12T18:22:41.123456Z",208 "email": "jane.doe@example.com",209 "full_name": "Jane Doe",210 "organization_role": "admin"211 }212 ],213 "has_more": true,214 "next_page": "cGFnZV90b2tlbl9leGFtcGxlXzE3MzQ1Njc4OTA="215}216```217218## Organizations › Roles219220### List Compliance Roles221222**GET** `/v1/compliance/organizations/{org_uuid}/roles`223224List Compliance Roles225226#### Path parameters227228- `org_uuid: string`229230 The organization UUID231232#### Query parameters233234- `limit: optional number`235236 Maximum results (default: 500, max: 1000)237238 default: 500, maximum: 1000, minimum: 1239240- `page: optional string`241242 Opaque pagination token from a previous response's `next_page` field. Pass this to retrieve the next page of results. Clients should treat this value as an opaque string and not attempt to parse or interpret its contents, as the format may change without notice.243244#### Headers245246- `"x-api-key": optional string`247248#### Returns249250- `data: array of object`251252 List of roles253254 - `id: string`255256 Role identifier (tagged ID)257258 - `created_at: string or null`259260 Role creation timestamp (RFC 3339)261262 format: date-time263264 - `description: string`265266 Role description267268 - `name: string`269270 Role name271272 - `updated_at: string or null`273274 Role last-updated timestamp (RFC 3339)275276 format: date-time277278- `has_more: boolean`279280 Whether more records exist beyond the current result set281282- `next_page: string or null`283284 Token to retrieve the next page. Use this as the 'page' parameter in your next request285286#### Example287288```bash289curl https://api.anthropic.com/v1/compliance/organizations/$ORG_UUID/roles \290 -H 'anthropic-version: 2023-06-01' \291 -H "Authorization: Bearer $ANTHROPIC_COMPLIANCE_API_KEY"292```293294##### Response (200)295296```json297{298 "data": [299 {300 "id": "rbac_role_01SGBg3kEnZrdsVR2QmyJbvD",301 "created_at": "2025-03-12T18:22:41.123456Z",302 "description": "Full administrative access to organization settings and members",303 "name": "Organization Admin",304 "updated_at": "2025-03-14T09:05:17.456789Z"305 }306 ],307 "has_more": true,308 "next_page": "cGFnZV90b2tlbl9leGFtcGxlXzE3MzQ1Njc4OTA="309}310```311312### Get Compliance Role313314**GET** `/v1/compliance/organizations/{org_uuid}/roles/{role_id}`315316Get Compliance Role317318#### Path parameters319320- `org_uuid: string`321322 The organization UUID323324- `role_id: string`325326 The role ID (tagged ID, e.g., rbac_role_abc123)327328#### Headers329330- `"x-api-key": optional string`331332#### Returns333334- `id: string`335336 Role identifier (tagged ID)337338- `created_at: string or null`339340 Role creation timestamp (RFC 3339)341342 format: date-time343344- `description: string`345346 Role description347348- `name: string`349350 Role name351352- `updated_at: string or null`353354 Role last-updated timestamp (RFC 3339)355356 format: date-time357358#### Example359360```bash361curl https://api.anthropic.com/v1/compliance/organizations/$ORG_UUID/roles/$ROLE_ID \362 -H 'anthropic-version: 2023-06-01' \363 -H "Authorization: Bearer $ANTHROPIC_COMPLIANCE_API_KEY"364```365366##### Response (200)367368```json369{370 "id": "rbac_role_01SGBg3kEnZrdsVR2QmyJbvD",371 "created_at": "2025-03-12T18:22:41.123456Z",372 "description": "Full administrative access to organization settings and members",373 "name": "Organization Admin",374 "updated_at": "2025-03-14T09:05:17.456789Z"375}376```377378## Organizations › Roles › Permissions379380### List Compliance Role Permissions381382**GET** `/v1/compliance/organizations/{org_uuid}/roles/{role_id}/permissions`383384List Compliance Role Permissions385386#### Path parameters387388- `org_uuid: string`389390 The organization UUID391392- `role_id: string`393394 The role ID (tagged ID, e.g., rbac_role_abc123)395396#### Query parameters397398- `limit: optional number`399400 Maximum results (default: 500, max: 1000)401402 default: 500, maximum: 1000, minimum: 1403404- `page: optional string`405406 Opaque pagination token from a previous response's `next_page` field. Pass this to retrieve the next page of results. Clients should treat this value as an opaque string and not attempt to parse or interpret its contents, as the format may change without notice.407408#### Headers409410- `"x-api-key": optional string`411412#### Returns413414- `data: array of object`415416 List of permissions417418 - `action: string`419420 Action permitted on the resource421422 - `resource_id: string`423424 Identifier of the resource the permission applies to425426 - `resource_type: string`427428 Type of resource the permission applies to429430- `has_more: boolean`431432 Whether more records exist beyond the current result set433434- `next_page: string or null`435436 Token to retrieve the next page. Use this as the 'page' parameter in your next request437438#### Example439440```bash441curl https://api.anthropic.com/v1/compliance/organizations/$ORG_UUID/roles/$ROLE_ID/permissions \442 -H 'anthropic-version: 2023-06-01' \443 -H "Authorization: Bearer $ANTHROPIC_COMPLIANCE_API_KEY"444```445446##### Response (200)447448```json449{450 "data": [451 {452 "action": "claude_code",453 "resource_id": "a1b2c3d4-e5f6-4789-a012-3456789abcde",454 "resource_type": "organization"455 }456 ],457 "has_more": true,458 "next_page": "cGFnZV90b2tlbl9leGFtcGxlXzE3MzQ1Njc4OTA="459}460```461462## Organizations › Settings463464### Get effective organization settings465466**GET** `/v1/compliance/organizations/{organization_id}/settings`467468Retrieve the effective settings for an organization.469470Returns the settings currently in force for the given organization — the471enforced state after all policies are applied, which may differ from what472is configured in the admin console. Settings an organization's473administrators cannot change (for example, ones controlled by Anthropic474policy or not available to the organization) are omitted from the list.475Settings that report a compliance arrangement with Anthropic are the476exception: the HIPAA and Access Transparency settings are always included;477the API zero data retention setting is reported for Claude Console478organizations, and the Claude Code zero data retention and customer-managed479encryption keys (CMEK) settings for Claude Enterprise organizations. Each480reports whether the arrangement is in place at the organization level; a481retention setting on an individual workspace is not reflected.482483The organization must belong to the API key's organization hierarchy;484unknown organizations and organizations outside the hierarchy return 404.485486#### Path parameters487488- `organization_id: string`489490 The organization's UUID491492#### Headers493494- `"x-api-key": optional string`495496#### Returns497498- `type: optional "effective_organization_settings"`499500 default: effective_organization_settings501502- `api_keys: array of object`503504 Compliance API keys configured for the organization hierarchy, ordered by creation time ascending. Key secret values are never included.505506 - `type: optional "compliance_api_key"`507508 default: compliance_api_key509510 - `id: string`511512 Unique identifier for the API key.513514 - `created_at: string`515516 When the key was created.517518 format: date-time519520 - `created_by_id: string or null`521522 Identifier of the user who created the key, or null when the key was created by automation or its creator's account no longer exists.523524 - `is_active: boolean`525526 Whether the key is currently active. A deactivated key is listed for audit visibility but cannot authenticate requests.527528 - `name: string`529530 The name given to the API key when it was created.531532 - `scopes: array of string`533534 The permission scopes granted to the key.535536 - `expires_at: optional string or null`537538 When the key will stop authenticating, or null when the key does not expire.539540 format: date-time541542- `organization_id: string`543544- `settings: array of Boolean or Integer or String or 3 more`545546 - `Boolean object`547548 A setting whose enforced value is a single true/false flag.549550 - `type: optional "boolean"`551552 default: boolean553554 - `name: "access_transparency_enabled" or "ai_powered_artifacts_enabled" or "api_workbench_feedback_collection_enabled" or 57 more`555556 - `"access_transparency_enabled"`557558 - `"ai_powered_artifacts_enabled"`559560 - `"api_workbench_feedback_collection_enabled"`561562 - `"api_zero_data_retention_enabled"`563564 - `"artifact_connectors_enabled"`565566 - `"ask_your_org_enabled"`567568 - `"chat_enabled"`569570 - `"claude_ai_chat_sharing_enabled"`571572 - `"claude_ai_feedback_collection_enabled"`573574 - `"claude_ai_integration_sharing_enabled"`575576 - `"claude_ai_skill_plugins_scanning_enabled"`577578 - `"claude_code_desktop_bypass_permissions_enabled"`579580 - `"claude_code_desktop_enabled"`581582 - `"claude_code_fast_mode_enabled"`583584 - `"claude_code_metrics_logging_enabled"`585586 - `"claude_code_remote_control_enabled"`587588 - `"claude_code_review_enabled"`589590 - `"claude_code_routines_enabled"`591592 - `"claude_code_security_enabled"`593594 - `"claude_code_trusted_devices_required"`595596 - `"claude_code_web_enabled"`597598 - `"claude_code_workflows_enabled"`599600 - `"claude_design_enabled"`601602 - `"claude_enterprise_claude_code_zero_data_retention_enabled"`603604 - `"claude_in_slack_enabled"`605606 - `"claude_science_custom_connectors_enabled"`607608 - `"claude_science_custom_skills_enabled"`609610 - `"claude_science_enabled"`611612 - `"claude_science_managed_network_allowlist_enabled"`613614 - `"claude_science_memory_enabled"`615616 - `"claude_science_modal_enabled"`617618 - `"claude_science_scientific_model_endpoints_enabled"`619620 - `"claude_science_ssh_hosts_enabled"`621622 - `"cmek_enabled"`623624 - `"code_execution_enabled"`625626 - `"code_execution_network_egress_enabled"`627628 - `"connector_tools_default_always_allow"`629630 - `"content_redaction_enabled"`631632 - `"cowork_trusted_devices_required"`633634 - `"desktop_extension_allowlist_enabled"`635636 - `"directory_sync_enabled"`637638 - `"frontier_data_use_enabled"`639640 - `"group_skill_sharing_enabled"`641642 - `"hipaa_compliance_enabled"`643644 - `"inline_visualizations_enabled"`645646 - `"ip_allowlist_enabled"`647648 - `"location_metadata_enabled"`649650 - `"member_usage_dashboard_visible"`651652 - `"memory_enabled"`653654 - `"org_wide_skill_sharing_enabled"`655656 - `"public_projects_enabled"`657658 - `"skill_sharing_enabled"`659660 - `"skills_enabled"`661662 - `"sso_claude_ai_enforced"`663664 - `"sso_console_enforced"`665666 - `"sso_enabled"`667668 - `"third_party_interactive_content_enabled"`669670 - `"user_skill_creation_enabled"`671672 - `"web_search_enabled"`673674 - `"work_across_apps_enabled"`675676 - `value: boolean`677678 - `Integer object`679680 A setting whose enforced value is a whole number; null means no limit681 is in force.682683 - `type: optional "integer"`684685 default: integer686687 - `name: "account_session_duration_seconds"`688689 - `value: number or null`690691 - `String object`692693 A setting whose enforced value is a single string; null means no value694 is configured.695696 - `type: optional "string"`697698 default: string699700 - `name: "claude_code_default_worker_environment_id" or "claude_code_default_worker_pool_id"`701702 - `"claude_code_default_worker_environment_id"`703704 - `"claude_code_default_worker_pool_id"`705706 - `value: string or null`707708 - `StringList object`709710 A setting whose enforced value is a list of strings.711712 - `type: optional "string_list"`713714 default: string_list715716 - `name: "allowed_invite_domains" or "disabled_admin_request_types" or "ip_allowlist_ip_ranges"`717718 - `"allowed_invite_domains"`719720 - `"disabled_admin_request_types"`721722 - `"ip_allowlist_ip_ranges"`723724 - `value: array of string`725726 - `ProvisioningMode object`727728 How organization members are provisioned, resolved to the enforced mode.729730 A configured mode is reported only while the mechanism that enforces it is731 active: just-in-time modes require single sign-on to be enabled, and SCIM732 modes require directory sync to be enabled. Otherwise `login_only` is733 reported, regardless of any stored configuration.734735 - `type: optional "provisioning_mode"`736737 default: provisioning_mode738739 - `value: "jit_advanced" or "jit_permissive" or "login_only" or 2 more`740741 How organization members are provisioned under SSO.742743 - `"jit_advanced"`744745 - `"jit_permissive"`746747 - `"login_only"`748749 - `"scim_advanced"`750751 - `"scim_permissive"`752753 - `name: optional "sso_provisioning_mode"`754755 default: sso_provisioning_mode756757 - `DataRetention object`758759 The data retention periods in force, keyed by the type of data they760 apply to.761762 A key of `all` covers every data type and is exclusive: when present it763 is the only key. A missing key means no organization-level764 administrator-configured retention period is in force for that data type;765 Anthropic's service defaults may still apply.766767 - `type: optional "data_retention"`768769 default: data_retention770771 - `value: map[Fixed or Indefinite]`772773 - `Fixed object`774775 A fixed retention window measured from each item's last activity.776777 - `type: optional "fixed"`778779 default: fixed780781 - `duration: number`782783 - `timescale: "day" or "month"`784785 - `"day"`786787 - `"month"`788789 - `Indefinite object`790791 An indefinite retention period: data is kept with no time limit.792793 - `type: optional "indefinite"`794795 default: indefinite796797 - `name: optional "data_retention_periods"`798799 default: data_retention_periods800801#### Example802803```bash804curl https://api.anthropic.com/v1/compliance/organizations/$ORGANIZATION_ID/settings \805 -H 'anthropic-version: 2023-06-01' \806 -H "Authorization: Bearer $ANTHROPIC_COMPLIANCE_API_KEY"807```808809##### Response (200)810811```json812{813 "api_keys": [814 {815 "id": "id",816 "created_at": "2019-12-27T18:11:19.117Z",817 "created_by_id": "created_by_id",818 "is_active": true,819 "name": "name",820 "scopes": [821 "string"822 ],823 "expires_at": "2019-12-27T18:11:19.117Z",824 "type": "compliance_api_key"825 }826 ],827 "organization_id": "organization_id",828 "settings": [829 {830 "name": "access_transparency_enabled",831 "value": true,832 "type": "boolean"833 }834 ],835 "type": "effective_organization_settings"836}837```838