Box Developer Documentation
Log in
Latest version

Get enterprise configuration

get
https://api.box.com/2.0
/enterprise_configurations/:enterprise_id

Retrieves the configuration for an enterprise.

Request

bearer [ACCESS_TOKEN]
application/json

Request Headers

stringin headerrequired

Version header.

Value is always 2025.0

Path Parameters

stringin pathrequired
3442311

The ID of the enterprise.

Query Parameters

string arrayin queryrequired
security,content_and_sharing,user_settings,shield

A comma-separated list of the enterprise configuration categories. Allowed values: security, content_and_sharing, user_settings, shield.

Response

application/jsonEnterprise configuration

Returns the enterprise configuration.

application/jsonClient error

An unexpected client error.

get
Get enterprise configuration
You can now try out some of our APIs live, right here in the documentation.
Log in

Request Example

Learn more about Box SDK versioning strategy.


Node/TypeScript v10
await adminClient.enterpriseConfigurations.getEnterpriseConfigurationByIdV2025R0(
  enterpriseId,
  {
    categories: ['user_settings', 'content_and_sharing', 'security', 'shield'],
  } satisfies GetEnterpriseConfigurationByIdV2025R0QueryParams,
);
Python v10
admin_client.enterprise_configurations.get_enterprise_configuration_by_id_v2025_r0(
    enterprise_id, ["user_settings", "content_and_sharing", "security", "shield"]
)
.NET v10
await adminClient.EnterpriseConfigurations.GetEnterpriseConfigurationByIdV2025R0Async(enterpriseId: enterpriseId, queryParams: new GetEnterpriseConfigurationByIdV2025R0QueryParams(categories: Array.AsReadOnly(new [] {"user_settings","content_and_sharing","security","shield"})));
Swift v10
try await adminClient.enterpriseConfigurations.getEnterpriseConfigurationByIdV2025R0(enterpriseId: enterpriseId, queryParams: GetEnterpriseConfigurationByIdV2025R0QueryParams(categories: ["user_settings", "content_and_sharing", "security", "shield"]))
Java v10
adminClient.getEnterpriseConfigurations().getEnterpriseConfigurationByIdV2025R0(enterpriseId, new GetEnterpriseConfigurationByIdV2025R0QueryParams(Arrays.asList("user_settings", "content_and_sharing", "security", "shield")))

Response Example

{
  "id": "11446498",
  "type": "enterprise_configuration",
  "content_and_sharing": {
    "auto_delete_days": {
      "is_used": true,
      "value": 1234
    },
    "auto_delete_target": {
      "is_used": true,
      "value": "value of configuration"
    },
    "collaboration_expiration_days": {
      "is_used": true,
      "value": 1234
    },
    "collaboration_expiration_target": {
      "is_used": true,
      "value": "value of configuration"
    },
    "collaboration_permissions": {
      "is_used": true,
      "value": {
        "is_co_owner_role_enabled": true,
        "is_editor_role_enabled": true,
        "is_previewer_role_enabled": true,
        "is_previewer_uploader_role_enabled": true,
        "is_uploader_role_enabled": true,
        "is_viewer_role_enabled": true,
        "is_viewer_uploader_role_enabled": true
      }
    },
    "collaboration_restrictions": {
      "is_used": true,
      "value": [
        "internal"
      ]
    },
    "default_collaboration_role": {
      "is_used": true,
      "value": "value of configuration"
    },
    "enterprise_feature_settings": [
      {
        "is_used": true,
        "value": {
          "allowlist": [
            {
              "id": "12345",
              "type": "user"
            }
          ],
          "can_configure": true,
          "denylist": [
            {
              "id": "12345",
              "type": "user"
            }
          ],
          "feature": {
            "id": "canvas"
          },
          "id": "eyJlbnRlcnByaXNlSWQiOiIxMTExNDQyNzY3IiwiZmVhdHVyZUlkIjoiY2FudmFzIn0=",
          "is_configured": true,
          "state": "enabled"
        }
      }
    ],
    "external_collaboration_allowlist_users": {
      "is_used": true,
      "value": [
        {
          "email": "johndoe@box.com",
          "id": 1234,
          "name": "John Doe"
        }
      ]
    },
    "external_collaboration_status": {
      "is_used": true,
      "value": "enable_external_collaboration"
    },
    "is_auto_delete_enabled": {
      "is_used": true,
      "value": true
    },
    "is_auto_delete_expiration_modification_prevented": {
      "is_used": true,
      "value": true
    },
    "is_cc_free_trial_active": {
      "is_used": true,
      "value": true
    },
    "is_collaboration_expiration_enabled": {
      "is_used": true,
      "value": true
    },
    "is_collaboration_expiration_modification_prevented": {
      "is_used": true,
      "value": true
    },
    "is_collaboration_expiration_notification_enabled": {
      "is_used": true,
      "value": true
    },
    "is_collaborator_invite_links_disabled": {
      "is_used": true,
      "value": true
    },
    "is_custom_domain_hidden_in_shared_link": {
      "is_used": true,
      "value": true
    },
    "is_custom_settings_enabled": {
      "is_used": true,
      "value": true
    },
    "is_email_uploads_enabled": {
      "is_used": true,
      "value": true
    },
    "is_file_request_branding_default_enabled": {
      "is_used": true,
      "value": true
    },
    "is_file_request_editors_allowed": {
      "is_used": true,
      "value": true
    },
    "is_file_request_login_required": {
      "is_used": true,
      "value": true
    },
    "is_forms_branding_default_enabled": {
      "is_used": true,
      "value": true
    },
    "is_forms_login_required": {
      "is_used": true,
      "value": true
    },
    "is_invite_group_collaborator_disabled": {
      "is_used": true,
      "value": true
    },
    "is_invite_privilege_restricted": {
      "is_used": true,
      "value": true
    },
    "is_open_custom_urls_disabled": {
      "is_used": true,
      "value": true
    },
    "is_ownership_transfer_restricted": {
      "is_used": true,
      "value": true
    },
    "is_public_shared_links_expiration_enabled": {
      "is_used": true,
      "value": true
    },
    "is_root_content_creation_restricted": {
      "is_used": true,
      "value": true
    },
    "is_shared_links_expiration_enabled": {
      "is_used": true,
      "value": true
    },
    "is_shared_links_expiration_notification_enabled": {
      "is_used": true,
      "value": true
    },
    "is_shared_links_expiration_notification_prevented": {
      "is_used": true,
      "value": true
    },
    "is_tag_creation_restricted": {
      "is_used": true,
      "value": true
    },
    "is_watermarking_enterprise_feature_enabled": {
      "is_used": true,
      "value": true
    },
    "permanent_deletion_access": {
      "is_used": true,
      "value": "value of configuration"
    },
    "permanent_deletion_allowlist_users": {
      "is_used": true,
      "value": [
        {
          "email": "johndoe@box.com",
          "id": 1234,
          "name": "John Doe"
        }
      ]
    },
    "public_shared_links_expiration_days": {
      "is_used": true,
      "value": 1234
    },
    "shared_expiration_target": {
      "is_used": true,
      "value": "value of configuration"
    },
    "shared_link_access": {
      "is_used": true,
      "value": "value of configuration"
    },
    "shared_link_company_definition": {
      "is_used": true,
      "value": "value of configuration"
    },
    "shared_link_default_access": {
      "is_used": true,
      "value": "value of configuration"
    },
    "shared_link_default_permissions_selected": {
      "is_used": true,
      "value": {
        "default_notes_shared_link_type": "settings_default_notes_shared_link_to_edit",
        "default_shared_link_type": "settings_default_shared_link_preview",
        "notes_shared_link_option": "settings_notes_option_to_edit",
        "shared_links_option": "settings_shared_link_preview"
      }
    },
    "shared_links_expiration_days": {
      "is_used": true,
      "value": 1234
    },
    "shared_links_expiration_notification_days": {
      "is_used": true,
      "value": 1234
    },
    "sharing_item_type": {
      "is_used": true,
      "value": "value of configuration"
    },
    "tag_creation_restriction": {
      "is_used": true,
      "value": "value of configuration"
    },
    "trash_auto_clear_time": {
      "is_used": true,
      "value": 1234
    }
  },
  "security": {
    "custom_session_duration_groups": {
      "is_used": true,
      "value": [
        {
          "id": "1234",
          "name": "Group Name"
        }
      ]
    },
    "custom_session_duration_value": {
      "is_used": true,
      "value": "value of configuration"
    },
    "enforced_mfa_frequency": {
      "is_used": true,
      "value": {
        "days": 30,
        "hours": 24
      }
    },
    "external_collab_multi_factor_auth_settings": {
      "is_used": true,
      "value": {
        "allowlist_domains": [
          "example.com"
        ],
        "allowlist_emails": [
          "mail@example.com"
        ],
        "denylist_domains": [
          "example.com"
        ],
        "denylist_emails": [
          "spam@example.com"
        ],
        "factor_type_settings": "totp",
        "scheduled_at": "2012-12-12T10:53:43-08:00",
        "scheduled_status": "inprogress",
        "state": "enabled"
      }
    },
    "failed_login_attempts_to_trigger_admin_notification": {
      "is_used": true,
      "value": 1234
    },
    "is_custom_session_duration_enabled": {
      "is_used": true,
      "value": true
    },
    "is_managed_user_email_change_disabled": {
      "is_used": true,
      "value": true
    },
    "is_managed_user_migration_disabled": {
      "is_used": true,
      "value": true
    },
    "is_managed_user_signup_corporate_email_enabled": {
      "is_used": true,
      "value": true
    },
    "is_managed_user_signup_enabled": {
      "is_used": true,
      "value": true
    },
    "is_managed_user_signup_notification_enabled": {
      "is_used": true,
      "value": true
    },
    "is_multi_factor_auth_required": {
      "is_used": true,
      "value": true
    },
    "is_new_user_notification_daily_digest_enabled": {
      "is_used": true,
      "value": true
    },
    "is_password_change_notification_enabled": {
      "is_used": true,
      "value": true
    },
    "is_password_leak_detection_enabled": {
      "is_used": true,
      "value": true
    },
    "is_password_request_notification_enabled": {
      "is_used": true,
      "value": true
    },
    "is_strong_password_for_ext_collab_enabled": {
      "is_used": true,
      "value": true
    },
    "is_weak_password_prevention_enabled": {
      "is_used": true,
      "value": true
    },
    "join_link": {
      "is_used": true,
      "value": "value of configuration"
    },
    "join_url": {
      "is_used": true,
      "value": "value of configuration"
    },
    "keysafe": {
      "is_used": true,
      "value": {
        "account_id": "1234",
        "cloud_provider": "",
        "key_id": "1234",
        "keyring_id": "1234",
        "keysafe_enabled": true,
        "location_id": "1234",
        "project_id": "1234"
      }
    },
    "last_password_reset_at": {
      "is_used": true,
      "value": "2012-12-12T10:53:43-08:00"
    },
    "multi_factor_auth_type": {
      "is_used": true,
      "value": "value of configuration"
    },
    "password_min_length": {
      "is_used": true,
      "value": 1234
    },
    "password_min_numeric_characters": {
      "is_used": true,
      "value": 1234
    },
    "password_min_special_characters": {
      "is_used": true,
      "value": 1234
    },
    "password_min_uppercase_characters": {
      "is_used": true,
      "value": 1234
    },
    "password_reset_frequency": {
      "is_used": true,
      "value": "value of configuration"
    },
    "previous_password_reuse_limit": {
      "is_used": true,
      "value": "value of configuration"
    },
    "session_duration": {
      "is_used": true,
      "value": "value of configuration"
    }
  },
  "shield": {
    "shield_rules": [
      {
        "created_at": "2012-12-12T10:53:43-08:00",
        "description": "Blocks files identified as malicious content",
        "id": "1234567890",
        "modified_at": "2012-12-12T10:53:43-08:00",
        "name": "Block malicious files",
        "priority": "high",
        "rule_category": "Malicious Content",
        "type": "shield_rule"
      }
    ]
  },
  "user_settings": {
    "enterprise_feature_settings": [
      {
        "is_used": true,
        "value": {
          "allowlist": [
            {
              "id": "12345",
              "type": "user"
            }
          ],
          "can_configure": true,
          "denylist": [
            {
              "id": "12345",
              "type": "user"
            }
          ],
          "feature": {
            "id": "canvas"
          },
          "id": "eyJlbnRlcnByaXNlSWQiOiIxMTExNDQyNzY3IiwiZmVhdHVyZUlkIjoiY2FudmFzIn0=",
          "is_configured": true,
          "state": "enabled"
        }
      }
    ],
    "is_box_sync_restricted_for_new_users": {
      "is_used": true,
      "value": true
    },
    "is_device_limit_exemption_enabled_for_new_users": {
      "is_used": true,
      "value": true
    },
    "is_enterprise_sso_in_testing": {
      "is_used": true,
      "value": true
    },
    "is_enterprise_sso_required": {
      "is_used": true,
      "value": true
    },
    "is_external_collaboration_restricted_for_new_users": {
      "is_used": true,
      "value": true
    },
    "is_instant_login_restricted": {
      "is_used": true,
      "value": true
    },
    "is_sso_auto_add_groups_enabled": {
      "is_used": true,
      "value": true
    },
    "is_sso_auto_add_user_to_groups_enabled": {
      "is_used": true,
      "value": true
    },
    "is_sso_auto_remove_user_from_groups_enabled": {
      "is_used": true,
      "value": true
    },
    "is_unlimited_storage_enabled_for_new_users": {
      "is_used": true,
      "value": true
    },
    "is_username_change_restricted": {
      "is_used": true,
      "value": true
    },
    "is_view_all_users_enabled_for_new_users": {
      "is_used": true,
      "value": true
    },
    "new_user_default_language": {
      "is_used": true,
      "value": "English (US)"
    },
    "new_user_default_storage_limit": {
      "is_used": true,
      "value": 1234
    },
    "new_user_default_timezone": {
      "is_used": true,
      "value": "GMT-05:00 America\\/Chicago CDT"
    },
    "number_of_user_tracking_codes_remaining": {
      "is_used": true,
      "value": 1234
    },
    "user_invites_expiration_time_frame": {
      "is_used": true,
      "value": "7 days"
    },
    "user_tracking_codes": {
      "is_used": true,
      "value": [
        {
          "id": 1234,
          "name": "Employee ID"
        }
      ]
    }
  }
}