Box Developer Documentation
Log in

A beta version of the new Box developer documentation site is launching soon! Updated Developer Guides, modern API Reference, and AI-powered search are on the way to help you build with Box faster. Stay tuned for more updates.

Enterprise configuration

The enterprise configuration for a given enterprise.

string
11446498

The identifier of the enterprise configuration which is the ID of the enterprise.

string
enterprise_configuration

The value will always be enterprise_configuration.

Value is always enterprise_configuration

Enterprise configuration content and sharing object

The enterprise configurations for the content and sharing category.

Enterprise configuration security object

The enterprise configurations for the security category.

Enterprise configuration shield object

The enterprise configurations for the shield category. If shield is turned off for given enterprise, the response will be 404.

Enterprise configuration user settings object

The enterprise configurations for the user settings category.

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"
        }
      ]
    }
  }
}