Box Developer Documentation

Enterprise configuration content and sharing

The enterprise configuration for the content and sharing category.

The number of days before auto delete.

true

Indicates whether a configuration is used for a given enterprise.

1234

The value of the enterprise configuration as an integer.

The selected option of types for applying auto delete.

true

Indicates whether a configuration is used for a given enterprise.

value of configuration

The value of the enterprise configuration as a string.

The number of days before collaboration expiration.

true

Indicates whether a configuration is used for a given enterprise.

1234

The value of the enterprise configuration as an integer.

The selected option of types for applying collaboration expiration.

true

Indicates whether a configuration is used for a given enterprise.

value of configuration

The value of the enterprise configuration as a string.

The basic data included in each enterprise configuration response object.

true

Indicates whether a configuration is used for a given enterprise.

The collaboration permissions.

true

The co-owner role is enabled for collaboration.

true

The editor role is enabled for collaboration.

true

The previewer role is enabled for collaboration.

true

The previewer uploader role is enabled for collaboration.

true

The uploader role is enabled for collaboration.

true

The viewer role is enabled for collaboration.

true

The viewer uploader role is enabled for collaboration.

The collaboration restrictions for the enterprise.

true

Indicates whether a configuration is used for a given enterprise.

["internal"]

The current default collaboration role.

true

Indicates whether a configuration is used for a given enterprise.

value of configuration

The value of the enterprise configuration as a string.

true

Indicates whether a configuration is used for a given enterprise.

An enterprise feature setting.

string
eyJlbnRlcnByaXNlSWQiOiIxMTExNDQyNzY3IiwiZmVhdHVyZUlkIjoiY2FudmFzIn0=

The identifier of the enterprise feature setting.

object array

Enterprise feature setting is enabled for only this set of users and groups.

12345

The identifier of the user or group.

user

The type user or group.

Value is one of user,group

true

Whether the feature can be configured.

object array

Enterprise feature setting is enabled for everyone except this set of users and groups.

12345

The identifier of the user or group.

user

The type user or group.

Value is one of user,group

The feature.

string
canvas

The identifier of the feature.

true

Whether the feature is configured.

enabled

The state of the feature.

The external collaboration allowlist users.

true

Indicates whether a configuration is used for a given enterprise.

integer
1234

The ID of the user.

johndoe@box.com

The email of the user.

John Doe

The name of the user.

The external collaboration status.

true

Indicates whether a configuration is used for a given enterprise.

enable_external_collaboration

The external collaboration status.

Value is one of enable_external_collaboration,limit_collaboration_to_allowlisted_domains

Enables auto delete.

true

Indicates whether a configuration is used for a given enterprise.

true

The value of the enterprise configuration as a boolean.

Prevents users from modifying auto delete expiration.

true

Indicates whether a configuration is used for a given enterprise.

true

The value of the enterprise configuration as a boolean.

Indicates if the enterprise is on a free trial.

true

Indicates whether a configuration is used for a given enterprise.

true

The value of the enterprise configuration as a boolean.

Enables collaboration expiration.

true

Indicates whether a configuration is used for a given enterprise.

true

The value of the enterprise configuration as a boolean.

Prevents users from modifying collaboration expiration.

true

Indicates whether a configuration is used for a given enterprise.

true

The value of the enterprise configuration as a boolean.

Enables collaboration expiration notification.

true

Indicates whether a configuration is used for a given enterprise.

true

The value of the enterprise configuration as a boolean.

Enables custom settings.

true

Indicates whether a configuration is used for a given enterprise.

true

The value of the enterprise configuration as a boolean.

Enables email uploads.

true

Indicates whether a configuration is used for a given enterprise.

true

The value of the enterprise configuration as a boolean.

Company brand color and logo defaults to Logo for use on Brand Color for File Requests.

true

Indicates whether a configuration is used for a given enterprise.

true

The value of the enterprise configuration as a boolean.

Indicates if editors are allowed for file requests feature.

true

Indicates whether a configuration is used for a given enterprise.

true

The value of the enterprise configuration as a boolean.

Require uploaders to log in with a Box account for File Requests.

true

Indicates whether a configuration is used for a given enterprise.

true

The value of the enterprise configuration as a boolean.

Company brand color and logo defaults to Logo for use on Brand Color for Forms.

true

Indicates whether a configuration is used for a given enterprise.

true

The value of the enterprise configuration as a boolean.

Require uploaders to log in with a Box account for Forms.

true

Indicates whether a configuration is used for a given enterprise.

true

The value of the enterprise configuration as a boolean.

Disables users to invite group collaborators.

true

Indicates whether a configuration is used for a given enterprise.

true

The value of the enterprise configuration as a boolean.

Restrict invites to only admin, folder owners, and co-owners.

true

Indicates whether a configuration is used for a given enterprise.

true

The value of the enterprise configuration as a boolean.

Disables custom shared link URLs for public access.

true

Indicates whether a configuration is used for a given enterprise.

true

The value of the enterprise configuration as a boolean.

Prevents ownership transfer to external users.

true

Indicates whether a configuration is used for a given enterprise.

true

The value of the enterprise configuration as a boolean.

Only admins can create and delete first-level folders, files, and bookmarks.

true

Indicates whether a configuration is used for a given enterprise.

true

The value of the enterprise configuration as a boolean.

Only selected users can create tags.

true

Indicates whether a configuration is used for a given enterprise.

true

The value of the enterprise configuration as a boolean.

Enables watermarking enterprise feature.

true

Indicates whether a configuration is used for a given enterprise.

true

The value of the enterprise configuration as a boolean.

The selected option for who can delete items from the trash.

true

Indicates whether a configuration is used for a given enterprise.

value of configuration

The value of the enterprise configuration as a string.

The allowlist users for permanently deleting items from the trash.

true

Indicates whether a configuration is used for a given enterprise.

integer
1234

The ID of the user.

johndoe@box.com

The email of the user.

John Doe

The name of the user.

The selected option of types for applying shared link expiration.

true

Indicates whether a configuration is used for a given enterprise.

value of configuration

The value of the enterprise configuration as a string.

The selected option for the type of items that sharing is enable for.

true

Indicates whether a configuration is used for a given enterprise.

value of configuration

The value of the enterprise configuration as a string.

The selected option for tag creation restriction.

true

Indicates whether a configuration is used for a given enterprise.

value of configuration

The value of the enterprise configuration as a string.

The time before items are permanently deleted from the trash in seconds.

true

Indicates whether a configuration is used for a given enterprise.

1234

The value of the enterprise configuration as an integer.

Response Example

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