Repository Public
1---2title: Settings3url: https://platform.claude.com/docs/en/api/compliance/organizations/settings4---56# Settings78## Get effective organization settings910**GET** `/v1/compliance/organizations/{organization_id}/settings`1112Retrieve the effective settings for an organization.1314Returns the settings currently in force for the given organization — the15enforced state after all policies are applied, which may differ from what16is configured in the admin console. Settings an organization's17administrators cannot change (for example, ones controlled by Anthropic18policy or not available to the organization) are omitted from the list.19Settings that report a compliance arrangement with Anthropic are the20exception: the HIPAA and Access Transparency settings are always included;21the API zero data retention setting is reported for Claude Console22organizations, and the Claude Code zero data retention and customer-managed23encryption keys (CMEK) settings for Claude Enterprise organizations. Each24reports whether the arrangement is in place at the organization level; a25retention setting on an individual workspace is not reflected.2627The organization must belong to the API key's organization hierarchy;28unknown organizations and organizations outside the hierarchy return 404.2930### Path parameters3132- `organization_id: string`3334 The organization's UUID3536### Headers3738- `"x-api-key": optional string`3940### Returns4142- `type: optional "effective_organization_settings"`4344 default: effective_organization_settings4546- `api_keys: array of object`4748 Compliance API keys configured for the organization hierarchy, ordered by creation time ascending. Key secret values are never included.4950 - `type: optional "compliance_api_key"`5152 default: compliance_api_key5354 - `id: string`5556 Unique identifier for the API key.5758 - `created_at: string`5960 When the key was created.6162 format: date-time6364 - `created_by_id: string or null`6566 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.6768 - `is_active: boolean`6970 Whether the key is currently active. A deactivated key is listed for audit visibility but cannot authenticate requests.7172 - `name: string`7374 The name given to the API key when it was created.7576 - `scopes: array of string`7778 The permission scopes granted to the key.7980 - `expires_at: optional string or null`8182 When the key will stop authenticating, or null when the key does not expire.8384 format: date-time8586- `organization_id: string`8788- `settings: array of Boolean or Integer or String or 3 more`8990 - `Boolean object`9192 A setting whose enforced value is a single true/false flag.9394 - `type: optional "boolean"`9596 default: boolean9798 - `name: "access_transparency_enabled" or "ai_powered_artifacts_enabled" or "api_workbench_feedback_collection_enabled" or 57 more`99100 - `"access_transparency_enabled"`101102 - `"ai_powered_artifacts_enabled"`103104 - `"api_workbench_feedback_collection_enabled"`105106 - `"api_zero_data_retention_enabled"`107108 - `"artifact_connectors_enabled"`109110 - `"ask_your_org_enabled"`111112 - `"chat_enabled"`113114 - `"claude_ai_chat_sharing_enabled"`115116 - `"claude_ai_feedback_collection_enabled"`117118 - `"claude_ai_integration_sharing_enabled"`119120 - `"claude_ai_skill_plugins_scanning_enabled"`121122 - `"claude_code_desktop_bypass_permissions_enabled"`123124 - `"claude_code_desktop_enabled"`125126 - `"claude_code_fast_mode_enabled"`127128 - `"claude_code_metrics_logging_enabled"`129130 - `"claude_code_remote_control_enabled"`131132 - `"claude_code_review_enabled"`133134 - `"claude_code_routines_enabled"`135136 - `"claude_code_security_enabled"`137138 - `"claude_code_trusted_devices_required"`139140 - `"claude_code_web_enabled"`141142 - `"claude_code_workflows_enabled"`143144 - `"claude_design_enabled"`145146 - `"claude_enterprise_claude_code_zero_data_retention_enabled"`147148 - `"claude_in_slack_enabled"`149150 - `"claude_science_custom_connectors_enabled"`151152 - `"claude_science_custom_skills_enabled"`153154 - `"claude_science_enabled"`155156 - `"claude_science_managed_network_allowlist_enabled"`157158 - `"claude_science_memory_enabled"`159160 - `"claude_science_modal_enabled"`161162 - `"claude_science_scientific_model_endpoints_enabled"`163164 - `"claude_science_ssh_hosts_enabled"`165166 - `"cmek_enabled"`167168 - `"code_execution_enabled"`169170 - `"code_execution_network_egress_enabled"`171172 - `"connector_tools_default_always_allow"`173174 - `"content_redaction_enabled"`175176 - `"cowork_trusted_devices_required"`177178 - `"desktop_extension_allowlist_enabled"`179180 - `"directory_sync_enabled"`181182 - `"frontier_data_use_enabled"`183184 - `"group_skill_sharing_enabled"`185186 - `"hipaa_compliance_enabled"`187188 - `"inline_visualizations_enabled"`189190 - `"ip_allowlist_enabled"`191192 - `"location_metadata_enabled"`193194 - `"member_usage_dashboard_visible"`195196 - `"memory_enabled"`197198 - `"org_wide_skill_sharing_enabled"`199200 - `"public_projects_enabled"`201202 - `"skill_sharing_enabled"`203204 - `"skills_enabled"`205206 - `"sso_claude_ai_enforced"`207208 - `"sso_console_enforced"`209210 - `"sso_enabled"`211212 - `"third_party_interactive_content_enabled"`213214 - `"user_skill_creation_enabled"`215216 - `"web_search_enabled"`217218 - `"work_across_apps_enabled"`219220 - `value: boolean`221222 - `Integer object`223224 A setting whose enforced value is a whole number; null means no limit225 is in force.226227 - `type: optional "integer"`228229 default: integer230231 - `name: "account_session_duration_seconds"`232233 - `value: number or null`234235 - `String object`236237 A setting whose enforced value is a single string; null means no value238 is configured.239240 - `type: optional "string"`241242 default: string243244 - `name: "claude_code_default_worker_environment_id" or "claude_code_default_worker_pool_id"`245246 - `"claude_code_default_worker_environment_id"`247248 - `"claude_code_default_worker_pool_id"`249250 - `value: string or null`251252 - `StringList object`253254 A setting whose enforced value is a list of strings.255256 - `type: optional "string_list"`257258 default: string_list259260 - `name: "allowed_invite_domains" or "disabled_admin_request_types" or "ip_allowlist_ip_ranges"`261262 - `"allowed_invite_domains"`263264 - `"disabled_admin_request_types"`265266 - `"ip_allowlist_ip_ranges"`267268 - `value: array of string`269270 - `ProvisioningMode object`271272 How organization members are provisioned, resolved to the enforced mode.273274 A configured mode is reported only while the mechanism that enforces it is275 active: just-in-time modes require single sign-on to be enabled, and SCIM276 modes require directory sync to be enabled. Otherwise `login_only` is277 reported, regardless of any stored configuration.278279 - `type: optional "provisioning_mode"`280281 default: provisioning_mode282283 - `value: "jit_advanced" or "jit_permissive" or "login_only" or 2 more`284285 How organization members are provisioned under SSO.286287 - `"jit_advanced"`288289 - `"jit_permissive"`290291 - `"login_only"`292293 - `"scim_advanced"`294295 - `"scim_permissive"`296297 - `name: optional "sso_provisioning_mode"`298299 default: sso_provisioning_mode300301 - `DataRetention object`302303 The data retention periods in force, keyed by the type of data they304 apply to.305306 A key of `all` covers every data type and is exclusive: when present it307 is the only key. A missing key means no organization-level308 administrator-configured retention period is in force for that data type;309 Anthropic's service defaults may still apply.310311 - `type: optional "data_retention"`312313 default: data_retention314315 - `value: map[Fixed or Indefinite]`316317 - `Fixed object`318319 A fixed retention window measured from each item's last activity.320321 - `type: optional "fixed"`322323 default: fixed324325 - `duration: number`326327 - `timescale: "day" or "month"`328329 - `"day"`330331 - `"month"`332333 - `Indefinite object`334335 An indefinite retention period: data is kept with no time limit.336337 - `type: optional "indefinite"`338339 default: indefinite340341 - `name: optional "data_retention_periods"`342343 default: data_retention_periods344345### Example346347```bash348curl https://api.anthropic.com/v1/compliance/organizations/$ORGANIZATION_ID/settings \349 -H 'anthropic-version: 2023-06-01' \350 -H "Authorization: Bearer $ANTHROPIC_COMPLIANCE_API_KEY"351```352353#### Response (200)354355```json356{357 "api_keys": [358 {359 "id": "id",360 "created_at": "2019-12-27T18:11:19.117Z",361 "created_by_id": "created_by_id",362 "is_active": true,363 "name": "name",364 "scopes": [365 "string"366 ],367 "expires_at": "2019-12-27T18:11:19.117Z",368 "type": "compliance_api_key"369 }370 ],371 "organization_id": "organization_id",372 "settings": [373 {374 "name": "access_transparency_enabled",375 "value": true,376 "type": "boolean"377 }378 ],379 "type": "effective_organization_settings"380}381```382383## Domain types384385### Setting Retrieve Response386387- `SettingRetrieveResponse object`388389 The resolved settings in force for one organization at read time.390391 Settings appear at most once each, in a fixed relative order, and values392 reflect the enforced state. A setting the organization's administrators393 cannot change — for example, one controlled by Anthropic policy or not394 available to the organization — is omitted from the list. Settings that395 report a compliance arrangement with Anthropic are the exception: the396 HIPAA and Access Transparency settings are always included; the API zero397 data retention setting is reported for Claude Console organizations, and398 the Claude Code zero data retention and customer-managed encryption keys399 (CMEK) settings for Claude Enterprise organizations. Each reports whether400 the arrangement is in place at the organization level; a retention setting401 on an individual workspace is not reflected.402403 - `type: optional "effective_organization_settings"`404405 default: effective_organization_settings406407 - `api_keys: array of object`408409 Compliance API keys configured for the organization hierarchy, ordered by creation time ascending. Key secret values are never included.410411 - `type: optional "compliance_api_key"`412413 default: compliance_api_key414415 - `id: string`416417 Unique identifier for the API key.418419 - `created_at: string`420421 When the key was created.422423 format: date-time424425 - `created_by_id: string or null`426427 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.428429 - `is_active: boolean`430431 Whether the key is currently active. A deactivated key is listed for audit visibility but cannot authenticate requests.432433 - `name: string`434435 The name given to the API key when it was created.436437 - `scopes: array of string`438439 The permission scopes granted to the key.440441 - `expires_at: optional string or null`442443 When the key will stop authenticating, or null when the key does not expire.444445 format: date-time446447 - `organization_id: string`448449 - `settings: array of Boolean or Integer or String or 3 more`450451 - `Boolean object`452453 A setting whose enforced value is a single true/false flag.454455 - `type: optional "boolean"`456457 default: boolean458459 - `name: "access_transparency_enabled" or "ai_powered_artifacts_enabled" or "api_workbench_feedback_collection_enabled" or 57 more`460461 - `"access_transparency_enabled"`462463 - `"ai_powered_artifacts_enabled"`464465 - `"api_workbench_feedback_collection_enabled"`466467 - `"api_zero_data_retention_enabled"`468469 - `"artifact_connectors_enabled"`470471 - `"ask_your_org_enabled"`472473 - `"chat_enabled"`474475 - `"claude_ai_chat_sharing_enabled"`476477 - `"claude_ai_feedback_collection_enabled"`478479 - `"claude_ai_integration_sharing_enabled"`480481 - `"claude_ai_skill_plugins_scanning_enabled"`482483 - `"claude_code_desktop_bypass_permissions_enabled"`484485 - `"claude_code_desktop_enabled"`486487 - `"claude_code_fast_mode_enabled"`488489 - `"claude_code_metrics_logging_enabled"`490491 - `"claude_code_remote_control_enabled"`492493 - `"claude_code_review_enabled"`494495 - `"claude_code_routines_enabled"`496497 - `"claude_code_security_enabled"`498499 - `"claude_code_trusted_devices_required"`500501 - `"claude_code_web_enabled"`502503 - `"claude_code_workflows_enabled"`504505 - `"claude_design_enabled"`506507 - `"claude_enterprise_claude_code_zero_data_retention_enabled"`508509 - `"claude_in_slack_enabled"`510511 - `"claude_science_custom_connectors_enabled"`512513 - `"claude_science_custom_skills_enabled"`514515 - `"claude_science_enabled"`516517 - `"claude_science_managed_network_allowlist_enabled"`518519 - `"claude_science_memory_enabled"`520521 - `"claude_science_modal_enabled"`522523 - `"claude_science_scientific_model_endpoints_enabled"`524525 - `"claude_science_ssh_hosts_enabled"`526527 - `"cmek_enabled"`528529 - `"code_execution_enabled"`530531 - `"code_execution_network_egress_enabled"`532533 - `"connector_tools_default_always_allow"`534535 - `"content_redaction_enabled"`536537 - `"cowork_trusted_devices_required"`538539 - `"desktop_extension_allowlist_enabled"`540541 - `"directory_sync_enabled"`542543 - `"frontier_data_use_enabled"`544545 - `"group_skill_sharing_enabled"`546547 - `"hipaa_compliance_enabled"`548549 - `"inline_visualizations_enabled"`550551 - `"ip_allowlist_enabled"`552553 - `"location_metadata_enabled"`554555 - `"member_usage_dashboard_visible"`556557 - `"memory_enabled"`558559 - `"org_wide_skill_sharing_enabled"`560561 - `"public_projects_enabled"`562563 - `"skill_sharing_enabled"`564565 - `"skills_enabled"`566567 - `"sso_claude_ai_enforced"`568569 - `"sso_console_enforced"`570571 - `"sso_enabled"`572573 - `"third_party_interactive_content_enabled"`574575 - `"user_skill_creation_enabled"`576577 - `"web_search_enabled"`578579 - `"work_across_apps_enabled"`580581 - `value: boolean`582583 - `Integer object`584585 A setting whose enforced value is a whole number; null means no limit586 is in force.587588 - `type: optional "integer"`589590 default: integer591592 - `name: "account_session_duration_seconds"`593594 - `value: number or null`595596 - `String object`597598 A setting whose enforced value is a single string; null means no value599 is configured.600601 - `type: optional "string"`602603 default: string604605 - `name: "claude_code_default_worker_environment_id" or "claude_code_default_worker_pool_id"`606607 - `"claude_code_default_worker_environment_id"`608609 - `"claude_code_default_worker_pool_id"`610611 - `value: string or null`612613 - `StringList object`614615 A setting whose enforced value is a list of strings.616617 - `type: optional "string_list"`618619 default: string_list620621 - `name: "allowed_invite_domains" or "disabled_admin_request_types" or "ip_allowlist_ip_ranges"`622623 - `"allowed_invite_domains"`624625 - `"disabled_admin_request_types"`626627 - `"ip_allowlist_ip_ranges"`628629 - `value: array of string`630631 - `ProvisioningMode object`632633 How organization members are provisioned, resolved to the enforced mode.634635 A configured mode is reported only while the mechanism that enforces it is636 active: just-in-time modes require single sign-on to be enabled, and SCIM637 modes require directory sync to be enabled. Otherwise `login_only` is638 reported, regardless of any stored configuration.639640 - `type: optional "provisioning_mode"`641642 default: provisioning_mode643644 - `value: "jit_advanced" or "jit_permissive" or "login_only" or 2 more`645646 How organization members are provisioned under SSO.647648 - `"jit_advanced"`649650 - `"jit_permissive"`651652 - `"login_only"`653654 - `"scim_advanced"`655656 - `"scim_permissive"`657658 - `name: optional "sso_provisioning_mode"`659660 default: sso_provisioning_mode661662 - `DataRetention object`663664 The data retention periods in force, keyed by the type of data they665 apply to.666667 A key of `all` covers every data type and is exclusive: when present it668 is the only key. A missing key means no organization-level669 administrator-configured retention period is in force for that data type;670 Anthropic's service defaults may still apply.671672 - `type: optional "data_retention"`673674 default: data_retention675676 - `value: map[Fixed or Indefinite]`677678 - `Fixed object`679680 A fixed retention window measured from each item's last activity.681682 - `type: optional "fixed"`683684 default: fixed685686 - `duration: number`687688 - `timescale: "day" or "month"`689690 - `"day"`691692 - `"month"`693694 - `Indefinite object`695696 An indefinite retention period: data is kept with no time limit.697698 - `type: optional "indefinite"`699700 default: indefinite701702 - `name: optional "data_retention_periods"`703704 default: data_retention_periods705