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

Documentation Index

Fetch the complete documentation index at: https://developer.box.com/llms.txt

Use this file to discover all available pages before exploring further.

Learn more about Box SDK versioning strategy.

Authorizations

​
Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Headers

​
box-version
enum<string>
required

Version header.

Available options:
2025.0

Path Parameters

​
enterprise_id
string
required

The ID of the enterprise.

Query Parameters

​
categories
string[]
required

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

Response

Returns the enterprise configuration.

The enterprise configuration for a given enterprise.

​
id
string

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

Example:

"11446498"

​
type
enum<string>

The value will always be enterprise_configuration.

Available options:
enterprise_configuration
Example:

"enterprise_configuration"

​
security
Enterprise configuration security · object

The enterprise configurations for the security category.

​
content_and_sharing
Enterprise configuration content and sharing · object

The enterprise configurations for the content and sharing category.

​
user_settings
Enterprise configuration user settings · object

The enterprise configurations for the user settings category.

​
shield
Enterprise configuration shield · object

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