Skip to main content
Enterprise configurations which admins can interact with for a given enterprise.

​
Enterprise configuration

The enterprise configuration for a given enterprise.
PropertyTypeRequiredDescription
idstringNoThe identifier of the enterprise configuration which is the ID of the enterprise.
typeenum<string>NoThe value will always be enterprise_configuration. Available options: enterprise_configuration.
securityEnterprise configuration securityNoThe enterprise configurations for the security category. Can be null.
content_and_sharingEnterprise configuration content and sharingNoThe enterprise configurations for the content and sharing category. Can be null.
user_settingsEnterprise configuration user settingsNoThe enterprise configurations for the user settings category. Can be null.
shieldEnterprise configuration shieldNoThe enterprise configurations for the shield category. If shield is turned off for given enterprise, the response will be 404. Can be null.
Example
{
  "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"
      }
    ]
  }
}

​
Enterprise configuration content and sharing

The enterprise configuration for the content and sharing category.
PropertyTypeRequiredDescription
enterprise_feature_settingsarray of Enterprise feature settings itemNo
sharing_item_typeEnterprise configuration item with string valueNoThe selected option for the type of items that sharing is enable for.
shared_link_company_definitionEnterprise configuration item with string valueNoThe definition of the company for shared links (such as enterprise_id, users_with_email_domain).
shared_link_accessEnterprise configuration item with string valueNoThe selected option for who has access to shared links.
shared_link_default_accessEnterprise configuration item with string valueNoThe selected option for the access level of shared links.
shared_link_default_permissions_selectedEnterprise configuration itemNoThe permissions selected for shared links for each type.
is_open_custom_urls_disabledEnterprise configuration item with boolean valueNoDisables custom shared link URLs for public access.
is_custom_domain_hidden_in_shared_linkEnterprise configuration item with boolean valueNoHides the custom domain in shared links.
collaboration_permissionsEnterprise configuration itemNo
default_collaboration_roleEnterprise configuration item with string valueNoThe current default collaboration role.
is_invite_privilege_restrictedEnterprise configuration item with boolean valueNoRestrict invites to only admin, folder owners, and co-owners.
collaboration_restrictionsEnterprise configuration itemNoThe collaboration restrictions for the enterprise.
is_collaborator_invite_links_disabledEnterprise configuration item with boolean valueNoDisables users to invite collaborators using invite links.
is_invite_group_collaborator_disabledEnterprise configuration item with boolean valueNoDisables users to invite group collaborators.
is_ownership_transfer_restrictedEnterprise configuration item with boolean valueNoPrevents ownership transfer to external users.
external_collaboration_statusEnterprise configuration itemNoThe external collaboration status. Possible values: enable_external_collaboration, limit_collaboration_to_allowlisted_domains, limit_collaboration_to_users_within_enterprise.
external_collaboration_allowlist_usersEnterprise configuration itemNoThe external collaboration allowlist users.
is_watermarking_enterprise_feature_enabledEnterprise configuration item with boolean valueNoEnables watermarking enterprise feature.
is_root_content_creation_restrictedEnterprise configuration item with boolean valueNoOnly admins can create and delete first-level folders, files, and bookmarks.
is_tag_creation_restrictedEnterprise configuration item with boolean valueNoOnly selected users can create tags.
tag_creation_restrictionEnterprise configuration item with string valueNoThe selected option for tag creation restriction.
is_email_uploads_enabledEnterprise configuration item with boolean valueNoEnables email uploads.
is_custom_settings_enabledEnterprise configuration item with boolean valueNoEnables custom settings.
is_forms_login_requiredEnterprise configuration item with boolean valueNoRequire uploaders to log in with a Box account for Forms.
is_forms_branding_default_enabledEnterprise configuration item with boolean valueNoCompany brand color and logo defaults to Logo for use on Brand Color for Forms.
is_cc_free_trial_activeEnterprise configuration item with boolean valueNoIndicates if the enterprise is on a free trial.
is_file_request_editors_allowedEnterprise configuration item with boolean valueNoIndicates if editors are allowed for file requests feature.
is_file_request_branding_default_enabledEnterprise configuration item with boolean valueNoCompany brand color and logo defaults to Logo for use on Brand Color for File Requests.
is_file_request_login_requiredEnterprise configuration item with boolean valueNoRequire uploaders to log in with a Box account for File Requests.
is_shared_links_expiration_enabledEnterprise configuration item with boolean valueNoEnables shared links expiration.
shared_links_expiration_daysEnterprise configuration item with integer valueNoThe expiration time for shared links.
is_public_shared_links_expiration_enabledEnterprise configuration item with boolean valueNoEnables public shared links expiration.
public_shared_links_expiration_daysEnterprise configuration item with integer valueNoThe expiration time for public shared links.
shared_expiration_targetEnterprise configuration item with string valueNoThe selected option of types for applying shared link expiration.
is_shared_links_expiration_notification_enabledEnterprise configuration item with boolean valueNoEnables shared links expiration notification.
shared_links_expiration_notification_daysEnterprise configuration item with integer valueNoThe number of days before expiration to notify users.
is_shared_links_expiration_notification_preventedEnterprise configuration item with boolean valueNoPrevents users from disabling shared links expiration notification.
is_auto_delete_enabledEnterprise configuration item with boolean valueNoEnables auto delete.
auto_delete_daysEnterprise configuration item with integer valueNoThe number of days before auto delete.
is_auto_delete_expiration_modification_preventedEnterprise configuration item with boolean valueNoPrevents users from modifying auto delete expiration.
auto_delete_targetEnterprise configuration item with string valueNoThe selected option of types for applying auto delete.
is_collaboration_expiration_enabledEnterprise configuration item with boolean valueNoEnables collaboration expiration.
collaboration_expiration_daysEnterprise configuration item with integer valueNoThe number of days before collaboration expiration.
is_collaboration_expiration_modification_preventedEnterprise configuration item with boolean valueNoPrevents users from modifying collaboration expiration.
is_collaboration_expiration_notification_enabledEnterprise configuration item with boolean valueNoEnables collaboration expiration notification.
collaboration_expiration_targetEnterprise configuration item with string valueNoThe selected option of types for applying collaboration expiration.
trash_auto_clear_timeEnterprise configuration item with integer valueNoThe time before items are permanently deleted from the trash in seconds.
permanent_deletion_accessEnterprise configuration item with string valueNoThe selected option for who can delete items from the trash.
permanent_deletion_allowlist_usersEnterprise configuration itemNoThe allowlist users for permanently deleting items from the trash.
Example
{
  "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"
      }
    ]
  }
}

​
Enterprise configuration security

The enterprise configuration for the security category.
PropertyTypeRequiredDescription
is_managed_user_signup_enabledEnterprise configuration item with boolean valueNoDetermines if users are allowed to sign up on their own.
is_managed_user_signup_notification_enabledEnterprise configuration item with boolean valueNoDetermines if users must sign up with your corporate email.
is_managed_user_signup_corporate_email_enabledEnterprise configuration item with boolean valueNoWhen enabled, admin are emailed when new users are added.
is_new_user_notification_daily_digest_enabledEnterprise configuration item with boolean valueNoDepends on is_managed_user_signup_corporate_email_enabled. A true value represents In daily summary emails. A false value represents Immediately.
is_managed_user_email_change_disabledEnterprise configuration item with boolean valueNoWhen enabled, prevents users from changing their primary email address.
is_multi_factor_auth_requiredEnterprise configuration item with boolean valueNoDetermines if multi-factor authentication is required for all managed users.
is_weak_password_prevention_enabledEnterprise configuration item with boolean valueNoWhen enabled, prevents common words / email address to be used in a password.
is_password_leak_detection_enabledEnterprise configuration item with boolean valueNoEnables exposed password detection.
last_password_reset_atEnterprise configuration itemNo
is_password_request_notification_enabledEnterprise configuration item with boolean valueNoWhen enabled, admins are notified when users request a forget password email.
is_password_change_notification_enabledEnterprise configuration item with boolean valueNoWhen enabled, admins are notified when users change passwords in Settings.
is_strong_password_for_ext_collab_enabledEnterprise configuration item with boolean valueNoRequires strong passwords for External Collaborators.
is_managed_user_migration_disabledEnterprise configuration item with boolean valueNoDisables users from being migrated in or out of the enterprise.
join_linkEnterprise configuration item with string valueNoJoin url for self sign up. Depends on is_managed_user_signup_enabled. Applies if join_url is not used.
join_urlEnterprise configuration item with string valueNoJoin url for self sign up. Depends on is_managed_user_signup_enabled. Applies if join_link is not used.
failed_login_attempts_to_trigger_admin_notificationEnterprise configuration item with integer valueNoNumber of failed login attempts before the primary admin is notified.
password_min_lengthEnterprise configuration item with integer valueNoMinimum number of characters required for passwords.
password_min_uppercase_charactersEnterprise configuration item with integer valueNoMinimum number of upper case characters required in passwords.
password_min_numeric_charactersEnterprise configuration item with integer valueNoMinimum number of numbers required in passwords.
password_min_special_charactersEnterprise configuration item with integer valueNoMinimum number of symbols required in passwords.
password_reset_frequencyEnterprise configuration item with string valueNoDetermines if users must reset their passwords every specified time period.
previous_password_reuse_limitEnterprise configuration item with string valueNoNumber of previous passwords users are prevented from using.
session_durationEnterprise configuration item with string valueNoValue indicating time from the last activity a user can remain logged in without activity before being logged out.
external_collab_multi_factor_auth_settingsEnterprise configuration itemNoExternal Collaborators multi-factor authentication settings.
keysafeEnterprise configuration itemNo
is_custom_session_duration_enabledEnterprise configuration item with boolean valueNoEnables custom session duration for select users.
custom_session_duration_valueEnterprise configuration item with string valueNoValue indicating duration users from specified groups can remain logged in without activity before being logged out.
custom_session_duration_groupsEnterprise configuration itemNoGroups for custom session duration.
multi_factor_auth_typeEnterprise configuration item with string valueNoManaged Users multi-factor authentication requirement method type.
enforced_mfa_frequencyEnterprise configuration itemNoManaged Users multi-factor authentication frequency. The default authentication frequency is set to 30 days, with authentication time calculated from the most recent successful MFA login.
Example
{
  "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
    }
  }
}

​
Enterprise configuration shield

The enterprise configuration for the shield category.
PropertyTypeRequiredDescription
shield_rulesarray of Shield rule itemNoThe shield rules configuration for the enterprise.
Example
{
  "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"
    }
  ]
}

​
Enterprise configuration user settings

The enterprise configuration for the user settings category.
PropertyTypeRequiredDescription
enterprise_feature_settingsarray of Enterprise feature settings itemNo
user_invites_expiration_time_frameEnterprise configuration item with string valueNoDetermines the time frame for any unaccepted invitation to your Box enterprise account to expire.
is_username_change_restrictedEnterprise configuration item with boolean valueNoDetermines if users are restricted from changing their username in Account Settings.
is_box_sync_restricted_for_new_usersEnterprise configuration item with boolean valueNoDetermines if Box Sync is restricted for new users.
is_view_all_users_enabled_for_new_usersEnterprise configuration item with boolean valueNoDetermines if new users can see all managed users in their contacts when inviting collaborators.
is_device_limit_exemption_enabled_for_new_usersEnterprise configuration item with boolean valueNoDetermines if new users are exempt from the maximum number of devices specified in the Device Protection settings.
is_external_collaboration_restricted_for_new_usersEnterprise configuration item with boolean valueNoDetermines if new users will not be allowed to create folders that can have external collaborators.
is_unlimited_storage_enabled_for_new_usersEnterprise configuration item with boolean valueNoDetermines if new users are given unlimited storage.
new_user_default_storage_limitEnterprise configuration item with integer valueNoDetermines the default storage limit for new users. Does not apply if is_unlimited_storage_enabled_for_new_users is true.
new_user_default_timezoneEnterprise configuration item with string valueNoDetermines the default timezone for new users.
new_user_default_languageEnterprise configuration item with string valueNoDetermines the default language for new users.
is_enterprise_sso_requiredEnterprise configuration item with boolean valueNoValue indicating if SSO is required for all users.
is_enterprise_sso_in_testingEnterprise configuration item with boolean valueNoValue indicating if SSO is in testing mode for all users.
is_sso_auto_add_groups_enabledEnterprise configuration item with boolean valueNoDetermines if any new groups received for a user upon login through SSO but not present in the enterprise will be auto added to the enterprise.
is_sso_auto_add_user_to_groups_enabledEnterprise configuration item with boolean valueNoDetermines if a user will be added to enterprise groups received upon user login through SSO.
is_sso_auto_remove_user_from_groups_enabledEnterprise configuration item with boolean valueNoDetermines if a user will be removed from enterprise groups upon user login through SSO.
user_tracking_codesEnterprise configuration itemNoProperties that are assigned as additional values to users, like employee ID or region.
number_of_user_tracking_codes_remainingEnterprise configuration item with integer valueNoThe remaining number of user_tracking_codes that can be created.
is_instant_login_restrictedEnterprise configuration item with boolean valueNoDetermines if users are restricted from granting (limited) access for Box Support for troubleshooting.
Example
{
  "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
  }
}
Last modified on July 9, 2026