SPB Git

Repository Public

retrieve.md 9.0 KB 380 lines markdown

1---2title: Get effective organization settings3url: https://platform.claude.com/docs/en/api/compliance/organizations/settings/retrieve4---56# Get effective organization settings78**GET** `/v1/compliance/organizations/{organization_id}/settings`910Retrieve the effective settings for an organization.1112Returns the settings currently in force for the given organization — the13enforced state after all policies are applied, which may differ from what14is configured in the admin console. Settings an organization's15administrators cannot change (for example, ones controlled by Anthropic16policy or not available to the organization) are omitted from the list.17Settings that report a compliance arrangement with Anthropic are the18exception: the HIPAA and Access Transparency settings are always included;19the API zero data retention setting is reported for Claude Console20organizations, and the Claude Code zero data retention and customer-managed21encryption keys (CMEK) settings for Claude Enterprise organizations. Each22reports whether the arrangement is in place at the organization level; a23retention setting on an individual workspace is not reflected.2425The organization must belong to the API key's organization hierarchy;26unknown organizations and organizations outside the hierarchy return 404.2728## Path parameters2930- `organization_id: string`3132  The organization's UUID3334## Headers3536- `"x-api-key": optional string`3738## Returns3940- `type: optional "effective_organization_settings"`4142  default: effective_organization_settings4344- `api_keys: array of object`4546  Compliance API keys configured for the organization hierarchy, ordered by creation time ascending. Key secret values are never included.4748  - `type: optional "compliance_api_key"`4950    default: compliance_api_key5152  - `id: string`5354    Unique identifier for the API key.5556  - `created_at: string`5758    When the key was created.5960    format: date-time6162  - `created_by_id: string or null`6364    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.6566  - `is_active: boolean`6768    Whether the key is currently active. A deactivated key is listed for audit visibility but cannot authenticate requests.6970  - `name: string`7172    The name given to the API key when it was created.7374  - `scopes: array of string`7576    The permission scopes granted to the key.7778  - `expires_at: optional string or null`7980    When the key will stop authenticating, or null when the key does not expire.8182    format: date-time8384- `organization_id: string`8586- `settings: array of Boolean or Integer or String or 3 more`8788  - `Boolean object`8990    A setting whose enforced value is a single true/false flag.9192    - `type: optional "boolean"`9394      default: boolean9596    - `name: "access_transparency_enabled" or "ai_powered_artifacts_enabled" or "api_workbench_feedback_collection_enabled" or 57 more`9798      - `"access_transparency_enabled"`99100      - `"ai_powered_artifacts_enabled"`101102      - `"api_workbench_feedback_collection_enabled"`103104      - `"api_zero_data_retention_enabled"`105106      - `"artifact_connectors_enabled"`107108      - `"ask_your_org_enabled"`109110      - `"chat_enabled"`111112      - `"claude_ai_chat_sharing_enabled"`113114      - `"claude_ai_feedback_collection_enabled"`115116      - `"claude_ai_integration_sharing_enabled"`117118      - `"claude_ai_skill_plugins_scanning_enabled"`119120      - `"claude_code_desktop_bypass_permissions_enabled"`121122      - `"claude_code_desktop_enabled"`123124      - `"claude_code_fast_mode_enabled"`125126      - `"claude_code_metrics_logging_enabled"`127128      - `"claude_code_remote_control_enabled"`129130      - `"claude_code_review_enabled"`131132      - `"claude_code_routines_enabled"`133134      - `"claude_code_security_enabled"`135136      - `"claude_code_trusted_devices_required"`137138      - `"claude_code_web_enabled"`139140      - `"claude_code_workflows_enabled"`141142      - `"claude_design_enabled"`143144      - `"claude_enterprise_claude_code_zero_data_retention_enabled"`145146      - `"claude_in_slack_enabled"`147148      - `"claude_science_custom_connectors_enabled"`149150      - `"claude_science_custom_skills_enabled"`151152      - `"claude_science_enabled"`153154      - `"claude_science_managed_network_allowlist_enabled"`155156      - `"claude_science_memory_enabled"`157158      - `"claude_science_modal_enabled"`159160      - `"claude_science_scientific_model_endpoints_enabled"`161162      - `"claude_science_ssh_hosts_enabled"`163164      - `"cmek_enabled"`165166      - `"code_execution_enabled"`167168      - `"code_execution_network_egress_enabled"`169170      - `"connector_tools_default_always_allow"`171172      - `"content_redaction_enabled"`173174      - `"cowork_trusted_devices_required"`175176      - `"desktop_extension_allowlist_enabled"`177178      - `"directory_sync_enabled"`179180      - `"frontier_data_use_enabled"`181182      - `"group_skill_sharing_enabled"`183184      - `"hipaa_compliance_enabled"`185186      - `"inline_visualizations_enabled"`187188      - `"ip_allowlist_enabled"`189190      - `"location_metadata_enabled"`191192      - `"member_usage_dashboard_visible"`193194      - `"memory_enabled"`195196      - `"org_wide_skill_sharing_enabled"`197198      - `"public_projects_enabled"`199200      - `"skill_sharing_enabled"`201202      - `"skills_enabled"`203204      - `"sso_claude_ai_enforced"`205206      - `"sso_console_enforced"`207208      - `"sso_enabled"`209210      - `"third_party_interactive_content_enabled"`211212      - `"user_skill_creation_enabled"`213214      - `"web_search_enabled"`215216      - `"work_across_apps_enabled"`217218    - `value: boolean`219220  - `Integer object`221222    A setting whose enforced value is a whole number; null means no limit223    is in force.224225    - `type: optional "integer"`226227      default: integer228229    - `name: "account_session_duration_seconds"`230231    - `value: number or null`232233  - `String object`234235    A setting whose enforced value is a single string; null means no value236    is configured.237238    - `type: optional "string"`239240      default: string241242    - `name: "claude_code_default_worker_environment_id" or "claude_code_default_worker_pool_id"`243244      - `"claude_code_default_worker_environment_id"`245246      - `"claude_code_default_worker_pool_id"`247248    - `value: string or null`249250  - `StringList object`251252    A setting whose enforced value is a list of strings.253254    - `type: optional "string_list"`255256      default: string_list257258    - `name: "allowed_invite_domains" or "disabled_admin_request_types" or "ip_allowlist_ip_ranges"`259260      - `"allowed_invite_domains"`261262      - `"disabled_admin_request_types"`263264      - `"ip_allowlist_ip_ranges"`265266    - `value: array of string`267268  - `ProvisioningMode object`269270    How organization members are provisioned, resolved to the enforced mode.271272    A configured mode is reported only while the mechanism that enforces it is273    active: just-in-time modes require single sign-on to be enabled, and SCIM274    modes require directory sync to be enabled. Otherwise `login_only` is275    reported, regardless of any stored configuration.276277    - `type: optional "provisioning_mode"`278279      default: provisioning_mode280281    - `value: "jit_advanced" or "jit_permissive" or "login_only" or 2 more`282283      How organization members are provisioned under SSO.284285      - `"jit_advanced"`286287      - `"jit_permissive"`288289      - `"login_only"`290291      - `"scim_advanced"`292293      - `"scim_permissive"`294295    - `name: optional "sso_provisioning_mode"`296297      default: sso_provisioning_mode298299  - `DataRetention object`300301    The data retention periods in force, keyed by the type of data they302    apply to.303304    A key of `all` covers every data type and is exclusive: when present it305    is the only key. A missing key means no organization-level306    administrator-configured retention period is in force for that data type;307    Anthropic's service defaults may still apply.308309    - `type: optional "data_retention"`310311      default: data_retention312313    - `value: map[Fixed or Indefinite]`314315      - `Fixed object`316317        A fixed retention window measured from each item's last activity.318319        - `type: optional "fixed"`320321          default: fixed322323        - `duration: number`324325        - `timescale: "day" or "month"`326327          - `"day"`328329          - `"month"`330331      - `Indefinite object`332333        An indefinite retention period: data is kept with no time limit.334335        - `type: optional "indefinite"`336337          default: indefinite338339    - `name: optional "data_retention_periods"`340341      default: data_retention_periods342343## Example344345```bash346curl https://api.anthropic.com/v1/compliance/organizations/$ORGANIZATION_ID/settings \347    -H 'anthropic-version: 2023-06-01' \348    -H "Authorization: Bearer $ANTHROPIC_COMPLIANCE_API_KEY"349```350351### Response (200)352353```json354{355  "api_keys": [356    {357      "id": "id",358      "created_at": "2019-12-27T18:11:19.117Z",359      "created_by_id": "created_by_id",360      "is_active": true,361      "name": "name",362      "scopes": [363        "string"364      ],365      "expires_at": "2019-12-27T18:11:19.117Z",366      "type": "compliance_api_key"367    }368  ],369  "organization_id": "organization_id",370  "settings": [371    {372      "name": "access_transparency_enabled",373      "value": true,374      "type": "boolean"375    }376  ],377  "type": "effective_organization_settings"378}379```380
Files main
Menu

Theme