2021

​

End of Support for Obsolete Language Versions

​

Where to get support

​

Box Windows SDK v4.1.0 released

​

Bug Fixes

• add missing configureAwait(false) when awaiting to prevent deadlocks (#775) (b16267e)

​

New Features and Enhancements

• add configurable Timeout for BoxClient (#779) (ac842ed)
• add file request API (#777) (1098f75)
• add vanity_name to SharedLink (#782) (00a1e26)

• https://www.nuget.org/packages/Box.V2/4.1.0
• https://www.nuget.org/packages/Box.V2.Core/4.1.0

​

Box Python SDK v2.14.0 released

​

New Features and Enhancements

• Add admin_logs_streaming support for events stream (#623)
• Add vanity_name parameter for creating shared link to a file or folder (#637)
• Add getting files and file versions under retention for a retention policy assignment (#633)
• Support base item operations for WebLink class (#639)

​

Bug Fixes

• Limit cryptography to version <3.5.0 (#636)
• Avoid raising 404 when a thumbnail cannot be generated for a file (#642)

​

OAuth 2.0 Redirect URL Updates

​

Updates

• The Box Developer Console OAuth 2.0 application configuration section has a new button to add multiple redirect URIs
• Redirect URIs now force strict checking to match the URI passed in and URIs configured in the OAuth 2.0 application configuration
• Updated the redirect_uri query parameter wording on the GET /authorize endpoint page
• Updated the OAuth 2.0 setup, with SDK, and without SDK guide pages

​

Where to get support

​

Box Java SDK v2.58.0 released

​

New Features and Enhancements

• SDK support for new GET /events stream_type: admin_logs_streaming (#938)
• Adding BoxDeveloperEditionAPIConnection#getUserConnection to indicate that we can use this connection for managed users or app users (#940)

​

Bug Fixes

• Fix for deprecated enums still being used (#931)

​

New Shield Download Event

​

Updates

• Added a new section to the Smart Access event trigger documentation
• Added SHIELD_DOWNLOAD_BLOCKED to the enterprise event list

​

Where to get support

​

New Event Stream Live Monitoring stream_type

​

Updates

• Completely reorganized the events guide section for easier understanding, including adding additional information to all pages in the various sections
• Updated the OpenAPI specification for the GET /events endpoint to include the new stream_type option of admin_logs_streaming
• Added a new how to migrate stream_type page with steps on switching

​

Where to get support

​

Added Retention Policy Marker Based Pagination

​

Updates

• Added fields, limit, and marker query parameters to the GET /retention-policies and GET /retention-policies-id-assignments endpoints.
• Added limit and next_marker to the response object for retention policies and retention policy assignments

​

Where to get support

​

Extend Retention Via Files API

​

Updates

• Added a disposition_at field to the File(Full) resource
• Added a disposition_at parameter to the PUT file endpoint
• Added a note in the retention policy guide section

​

Where to get support

​

Box Windows SDK v4.0.0 released

​

Breaking changes

• Extract interfaces for BoxClient and Managers to improve testability (#603)
• Add BoxConfigBuilder and make BoxConfig immutable (#737)
• Expose tasks from async methods (#742)
• Use DateTimeOffset instead of DateTime (#749)
• Rework returned exceptions (#753)
• Upgrade .NET Standard to 2.0 (#755)

​

New Features and Enhancements

• Add ability to get files under retention for assignment and file versions under retention for assignment (#734)
• Add is_collaboration_restricted_to_enterprise flag support for Folder update (#732)
• Replace insensitive language (#738)
• Add new, easier to use method for create terms of service user status (#740)
• Allow sort and direction parameter to be passed in when getting trashed items (#754)
• Add support for Task completion_rule field (#758)
• Add BoxSign API support (#765)

​

Bug Fixes

• Fix Cannot access a closed Stream.Request exception during upload (#739) (#757)

• https://www.nuget.org/packages/Box.V2/4.0.0
• https://www.nuget.org/packages/Box.V2.Core/4.0.0

​

Box iOS SDK v5.0.0 released

​

Breaking changes

• Update PagingIterator to return pages and simplify logic (#737)
• Remove insensitive language field collaborationWhiteList in BoxClient. Use collaborationAllowList instead. (#790)

​

New Features and Enhancements

• Replace insensitive event types (#785)
• Add SignAPI support (#792)

​

Box Sign Enterprise Events

​

Updates

• Add sign request document events: created, converted, completed, cancelled and expired
• Add sign request signer events: assigned, viewed by signer, downloaded, forwarded, signed and declined
• Add two new statuses: downloaded and downloaded and signed

​

Box UI Elements v14.0.0 released

​

14.0.0 (2021-10-20)

​

Bug Fixes & Features

​

App Diagnostics Report Feedback

​

Box Java SDK v2.57.0 released

​

New Features and Enhancements

• Add support for marker-based paging in BoxFolder.getChildren (#927)
• Upgraded minimal-json to version 0.9.5
• Upgraded jose4j to version 0.7.9
• Adding Gradle wrapper in version 4.0.1 (#928)

​

Bug Fixes:**

• Fix for infinite recursion (#924)
• Fix unable to set Vanity URL on BoxSharedLink for BoxFile and BoxFolder (#925)

​

Update to Webhooks Response

​

Bug Fixes

• Added a mini resource for Webhook
• Corrected the get-webhooks response object

​

New App Diagnostics Report

​

Support for Adobe Creative Cloud Previews

​

Updates

• Thumbnails
• Image Viewer UI Element
• Annotations
• Thumbnail Representation

​

Box Python SDK v2.13.0 released

​

New Features and Enhancements

• Sensitive language replacement (#609)
• Add BoxSign support (#617)

​

Bug Fixes

• Upgrade cryptography to version 3 (#620)

​

Box Node SDK v2.0.0 released

​

Breaking changes

• Drop support for Node 6,7 (#670)

​

New Features and Enhancements

• Add support for is_external_collab_restricted User property (#668)
• Bump proxy-agent from 4.0.0 to 5.0.0 (#664)

​

EOS for Open With UI Element and EOL for Adobe Sign

• We will discontinue support of the Box Open With UI Element for Box Tools and Google Workspace for any new customers. A new customer is any customer not using this element prior to December 21. Any customers leveraging the Open With UI Element with Box Tools and/or Google Workspace prior to December 21 are considered existing customers and will continue to receive support until further notice. The Box Tools and Google Workspace Web App functionality will not be impacted.
• Adobe Sign will no longer be available for use by new or existing customers via the Open With UI element or Web Application.

​

New enhancements to retention APIs

​

Features

• Get files under retention: Returns a list of files under retention that are associated with the specified retention policy assignment.
• Get file versions under retention: Returns a list of file versions under retention that are associated with the specified retention policy assignment.
• Added an editable description field to the retention policy resource.
• Added a non-writable start_field_date to the retention policy assignment resource. This field is the metadata field’s key id. The value can also be upload_date if the assigned_to type is not metadata_template or a date field has not been selected.

​

Classification Name Field now in Events API

• The updates to the event source response object can be seen here.
• A new guide page has been added to show examples for an event triggered by a user source and an event source.

{
  "source": {
    "item_type": "file",
    "item_id": "8903212345",
    "item_name": "example.docx",
    "parent": {
      "type": "folder",
      "name": "All Files",
      "id": "0"
    },
    "owned_by": {
      "type": "user",
      "id": "11446498",
      "name": "Aaron Levie",
      "login": "notifications@example.com"
    }
  }
}

{
  "source": {
    "item_type": "file",
    "item_id": "8903212345",
    "item_name": "example.docx",
    "parent": {
      "type": "folder",
      "name": "All Files",
      "id": "0"
    },
    "owned_by": {
      "type": "user",
      "id": "11446498",
      "name": "Aaron Levie",
      "login": "notifications@example.com"
    },
    "classification": {
      "name": "Top Secret"
    }
  }
}

​

Where to get support

​

Notice of behavior change for item preview events

​

Change overview

​

Where to get support

​

Box Java SDK v2.56.0 released

​

New Features and Enhancements

• Replace submaster GroupMembershipRole with coadmin. Replace MASTER_INVITE_ACCEPT and MASTER_INVITE_REJECT with ADMIN_INVITE_ACCEPT and ADMIN_INVITE_REJECT. (#907)
• Add tracking_codes to create User API call (#910)

​

Bug Fixes

• Fix url for BoxFileRequest.Info object (#906)
• Attempt to fix thread locking issue on refresh of access token (#912)

​

Box Node SDK v1.39.0 released

​

New Features and Enhancements

• Add support for Box Sign API (#658)
• Enhance TS Imports (#656)

​

Box Node SDK v1.38.0 released

​

New Features and Enhancements

• Add sensitive language event types for admin invites (#648)
• Use BetterDocs to adapt JSDocs to TypeScript (#646)
• Change ProxyAgent import to be dynamic (#641)
• New API for get files and file versions under retention (#585)

​

Bug Fixes

• Deeply freeze Config except Buffers and Readable streams (#651)
• Fix a typo in docs of src/managers/search.ts (#649)
• Update broken documentation link (#647)
• fix type annotations for exchangeToken functions (#645)
• Deprecate files getThumbnail API in favor of getRepresentationContent (#627)

​

Upcoming change to JWT format

​

Change overview

​

Verifying application impact

1. Navigate to Admin Console > Apps Tab > Custom Apps.
2. Click View for each app row listed
3. Scroll to the bottom of the app details page and verify the selected authentication method. Affected apps will say Server Authentication with JSON Web Tokens.

1. Is it using an official Box SDK? If so, no further action is required to prepare for this change. While it is always best practice to be on the latest version, no minimum versions are required for compatibility.

2. If an official SDK is not used, are tokens stored in a database? If so, you will need to preform additional verification that the database can handle both the new length and special characters.

​

Testing before release

1. Generate an Access Token for the application

2. Downscope the token from step 1

3. Attempt to store the downscoped token in your database

​

Where to get support

​

New Getting Started Guide

​

Features

• Use case evaluation: Guide
• Common user models: Guide
• Common architecture patterns: Guide
• Locating common values: Guide
• Security overview: Guide
• Authentication best practices: Guide
• Detailed authorization steps: Guide

​

Box Java SDK v2.55.1 released

​

Bug Fixes

• Restore methods for Execute Metadata Query, which were removed in #890, and mark them as deprecated (#905)

​

Release of Box Sign API

curl -i -X PUT "https://api.box.com/2.0/sign_requests" \
     -H "Authorization: Bearer <ACCESS_TOKEN>" \
     -d '{
       "signers": [
          {    
            "role": "signer",
            "email": "example_email@box.com"
          }
        ],
       "source_files": [
          {
            "type": "file",
            "id": "123456789"
          }
       ],
       "parent_folder": 
          {
            "type": "folder",
            "id": "0987654321"
          }
     }'

​

Features

• Add endpoint to create Box Sign requests: Guide | API reference
• Add endpoint to list Box Sign requests: Guide | API reference
• Add endpoint to get Box Sign requests by ID: Guide | API reference
• Add endpoint to resend Box Sign requests: Guide | API reference
• Add endpoint to cancel Box Sign requests: Guide | API reference
• Java SDK support: GitHub

​

Box Java SDK v2.55.0 released

​

Breaking Changes

• Update execute metadata query to match API response (#890)
  • NOTE: This change removes a method without deprecating it. It was not possible to use the method correctly at all, because the underlying service no longer supported it.

​

New Features and Enhancements

• Remove or deprecate insensitive language ([#889])(https://github.com/box/box-java-sdk/pull/889)
• Add support for is_external_collab_restricted parameter for User (#896)
• Add configurable permissions support for GroupMembership (#897)
• Add SHIELD_JUSTIFICATION_APPROVAL event type (#898)
• Add ability to get files under retention for assignment and file versions under retention for assignment (#899)
• Add TASK_UPDATE, FILE_VERSION_RESTORE and ADVANCED_FOLDER_SETTINGS_UPDATE event types (#902)
• Add Box Sign API support (#904)

​

Bug Fixes

• Add setters for BoxLegalHoldPolicy (#885)
• Add setters for BoxTaskAssignment (#886)
• Add setters for Group Membership and Web Links (#887)
• Add setters for Webhooks (#888)
• Deprecate BoxFile.getThumbnail in favor of BoxFile.getRepresentationContent (#891)

​

Updated file size limits

​

Updates

• Enterprise: 50 GB
• Digital Workplace Suite: 50 GB
• Digital Workplace Global Suite: 50 GB
• Digital Business Suite: 50 GB
• Digital Business Global Suite: 50 GB
• Enterprise Plus: 150 GB

​

New Manual Start Workflow Endpoints

• Get workflows configured on a folder
• Start a manual start flow within a workflow for file(s)

​

Features

• New workflow resource
• New GET workflows endpoint
• New POST start manual workflow endpoint

​

Notice of behavior change for item open events

​

Change overview

​

Where to get support

​

Box Python SDK v2.12.1 Released

​

Bug Fixes

• Fix bug when thumbnail representations are not found (#597)

​

Box Node SDK v1.37.2 released

​

Bug Fixes

• Fix backwards compatibility issue by moving some TypeScript @types as direct dependencies (#630)

​

Box Node SDK v1.37.1 released

​

Bug Fixes

• Insensitive language: replace whitelist with allowlist (#625)

​

Box UI Elements v13.0.0 released

​

13.0.0 (2021-04-22)

​

Bug Fixes & Features

​

Box iOS SDK v4.4.0 released

​

Breaking Changes

​

New Features and Enhancements

• Add support for search parameter to get shared link items (#756)
• Add support for folder lock functionality (#759)
• Add support for copyInstanceOnItemCopy field for metadata templates (#763)
• Add support for stream upload of new file versions and add support for ‘If-Match’ header when uploading new file versions (#766)
• Add additional details field for Event model (#770)

​

Bug Fixes:**

• Pass only a scheme to iOS Authentication APIs (#755)
• Update listEnterpriseGroups() to use documented parameter for filtering by name (#757)
• Fix bug for OAuth where the callback is not called if token has been revoked (#762)

​

Box Python SDK v2.12.0 released

​

New Features and Enhancements

• Add metadata query functionality (#574)
• Add folder lock functionality (#581)
• Add search query support for the include_recent_shared_links field (#582)
• Update get_groups() to use documented parameter to filter by name (#586)

​

Box Node SDK v1.37.0 released

​

New Features and Enhancements

• Add support for copyInstanceOnItemCopy field for metadata templates (#572)

​

Bug Fixes

• Fix webhook signature validation (#568)
• Update dependencies to patch security vulnerabilities (#578)

​

Notice of behavior change for item download events

​

Change overview

​

Where to get support

​

New option for downscoping tokens using shared links

​

Updates

• Added new box_shared_link request parameter to downscoping documentation. A shared link may be supplied to downscope an access token in the below way.

{
  curl -i -X POST "https://api.box.com/oauth2/token" \
     -H "Content-Type: application/x-www-form-urlencoded" \
     -d "subject_token=[ACCESS_TOKEN]" \
     -d "subject_token_type=urn:ietf:params:oauth:token-type:access_token" \
     -d "scope=item_upload item_preview base_explorer" \
     -d "box_shared_link=https://cloud.box.com/s/123456" \
     -d "grant_type=urn:ietf:params:oauth:grant-type:token-exchange"
}

• Added box_shared_link request parameter to request access token API reference.

​

Box Java SDK v2.54.0 released

​

New Features and Enhancements

• Add file request support (#869)

​

Bug Fixes

• Fix BoxWeblink deserialization (#881)

​

Service Account email added to Developer Console

​

Features

• Added auto-generated email address of Service Account user to Developer Console

​

New Metadata Query Indices Endpoint

​

Features

• New API endpoint to get a list of metadata query indices by scope and template.
• New metadata query index response object.
• New metadata query indices response object.

​

Updates

• Updated metadata query indices guide to include details on how to get a list of metadata query indices.

​

New Collection Events

• COLLECTION_CREATE: A collection was created
• COLLECTION_DELETE: A collection was deleted
• COLLECTION_UPDATE: A collection was updated
• COLLECTION_ITEM_CREATE: An item was added to a collection
• COLLECTION_ITEM_DELETE: An item was removed from a collection
• COLLECTION_ITEM_UPDATE: An item in a collection was updated

​

Box Shield Smart Access events

​

Features

• Add support for Box Shield external collaboration and justification approval events to the enterprise events stream

​

Box CLI v2.9.0 released

​

New Features and Enhancements

• Add ability to add an option to a metadata template multi select field (#230)
• Add folder lock functionality (#232)
• Add support for search parameter to get shared link items (#233)

​

Bug Fixes

• Fix events command bug when there is no stream position flag (#234)
• Fix bug with folders:upload command not uploading folder contents (#231)

​

Box API response header changes that may impact your applications

• Salesforce SDK v1 users will be impacted and will need to upgrade to a recent SDK version. Not doing so will cause your Box Salesforce integration to cease functioning after May 10th, 2021.
• Box API consumers who do not use one of the Box SDKs may be impacted and will need to verify header usage through their code. Depending on your header usage, not making adjustments may cause disruptions in your Box API integration.

​

Change overview

​

API Consumers: Verifying application impact

• Locate the code in your application which handles the responses from Box API requests. If you are not extracting the response headers from these responses, you are not impacted.
• If you are extracting those response headers, you may be impacted if you are expecting those headers in a case-sensitive fashion.

​

API Consumers: How to make the change

​

Salesforce SDK v1 users: Verifying application impact

public final static String HEADER_LOCATION_LOWER_CASE = 'location';
public final static String HEADER_LOCATION_CAPITALIZED = 'Location';

​

Salesforce SDK v1 users: How to make the change

​

Where to get support

​

Box iOS SDK v4.3.0 released

​

Breaking Changes

​

New Features and Enhancements

• Add support for OAuth 2 custom callback URL (#746)
• Add support for zip download (#749)

​

Bug Fixes

• Update gems to patch kramdown vulnerability (#742)
• Update gems to patch activesupport vulnerability (#745)

​

Box Node SDK v1.36.0 released

​

New Features and Enhancements

• Add folder lock functionality (#560)
• Add support for filtering groups by name (#561)

​

Bug Fixes

• Update proxy-agent to patch proxy support issue (#563)
• Update dependencies to patch security vulnerabilities (#566)

​

Maximum upload file size limit increases

• Business Plus
• Enterprise
• Digital Workplace Suite
• Digital Workplace Global Suite

​

Metadata Query index changes

​

Previous Indexing Process

• Contact the metadata query team to request an index.
• The metadata query team would create the index and supply back the name of the newly created index.
• When making metadata query requests this index name was supplied as the value for the use_index key in the API request.

​

New Indexing Process

• Contact the metadata query team to request an index.

​

Developer Console Updates

• App Approval Process: Guide
• Scopes: Guide
• Application Access: Guide

​

Updates

• Added Authorization tab to the Developer Console
• Updated the UI for JWT Application Access settings under the Configuration tab
• Updated the UI grouping of Scopes under the Configuration tab

​

Box Python SDK v2.11.0 released

​

New Features and Enhancements

• Deprecate and add method for getting a thumbnail (#572)

​

Box Java SDK v2.53.0 released

​

New Features and Enhancements

• Add offset and limit parameters to BoxFolder.getChildren (#861)