Skip to main content
API version 2025.0 The enterprise configuration for the content and sharing category.
auto_delete_days
object
The number of days before auto delete.
auto_delete_target
object
The selected option of types for applying auto delete.
collaboration_expiration_days
object
The number of days before collaboration expiration.
collaboration_expiration_target
object
The selected option of types for applying collaboration expiration.
collaboration_permissions
object
The basic data included in each enterprise configuration response object.
collaboration_restrictions
object
The collaboration restrictions for the enterprise.
default_collaboration_role
object
The current default collaboration role.
enterprise_feature_settings
object[]
external_collaboration_allowlist_users
object
The external collaboration allowlist users.
external_collaboration_status
object
The external collaboration status. Possible values: enable_external_collaboration, limit_collaboration_to_allowlisted_domains, limit_collaboration_to_users_within_enterprise.
is_auto_delete_enabled
object
Enables auto delete.
is_auto_delete_expiration_modification_prevented
object
Prevents users from modifying auto delete expiration.
is_cc_free_trial_active
object
Indicates if the enterprise is on a free trial.
is_collaboration_expiration_enabled
object
Enables collaboration expiration.
is_collaboration_expiration_modification_prevented
object
Prevents users from modifying collaboration expiration.
is_collaboration_expiration_notification_enabled
object
Enables collaboration expiration notification.
Disables users to invite collaborators using invite links.
Hides the custom domain in shared links.
is_custom_settings_enabled
object
Enables custom settings.
is_email_uploads_enabled
object
Enables email uploads.
is_file_request_branding_default_enabled
object
Company brand color and logo defaults to Logo for use on Brand Color for File Requests.
is_file_request_editors_allowed
object
Indicates if editors are allowed for file requests feature.
is_file_request_login_required
object
Require uploaders to log in with a Box account for File Requests.
is_forms_branding_default_enabled
object
Company brand color and logo defaults to Logo for use on Brand Color for Forms.
is_forms_login_required
object
Require uploaders to log in with a Box account for Forms.
is_invite_group_collaborator_disabled
object
Disables users to invite group collaborators.
is_invite_privilege_restricted
object
Restrict invites to only admin, folder owners, and co-owners.
is_open_custom_urls_disabled
object
Disables custom shared link URLs for public access.
is_ownership_transfer_restricted
object
Prevents ownership transfer to external users.
Enables public shared links expiration.
is_root_content_creation_restricted
object
Only admins can create and delete first-level folders, files, and bookmarks.
Enables shared links expiration.
Enables shared links expiration notification.
Prevents users from disabling shared links expiration notification.
is_tag_creation_restricted
object
Only selected users can create tags.
is_watermarking_enterprise_feature_enabled
object
Enables watermarking enterprise feature.
permanent_deletion_access
object
The selected option for who can delete items from the trash.
permanent_deletion_allowlist_users
object
The allowlist users for permanently deleting items from the trash.
The expiration time for public shared links.
shared_expiration_target
object
The selected option of types for applying shared link expiration.
The selected option for who has access to shared links.
The definition of the company for shared links (such as enterprise_id, users_with_email_domain).
The selected option for the access level of shared links.
The permissions selected for shared links for each type.
The expiration time for shared links.
The number of days before expiration to notify users.
sharing_item_type
object
The selected option for the type of items that sharing is enable for.
tag_creation_restriction
object
The selected option for tag creation restriction.
trash_auto_clear_time
object
The time before items are permanently deleted from the trash in seconds.
{
  "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": "[email protected]",
        "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": "[email protected]",
        "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
  }
}