2022 - Box Dev Docs

New featuresNodeSDKs

Box Node SDK v2.8.0 released

New Features and Enhancements

Session termination (#782) (7fb56c6)

New featuresImpactful changesAPIJavaWindowsSDKs

Announcing major releases of Box SDKs

In January 2023, we plan two major releases of Box Windows V2 SDK and Box Java SDK.For Box Windows V2 SDK, we are changing the minimum supported version of .NET Framework from 4.5 to 4.6.2+. For Box Java SDK, we are replacing networking library and introducing OkHttp which will give SDK support of HTTP2 protocol and allow users to use proxies beyond basic authentication.For both SDKs, we are removing deprecated APIs.

Read more about changes to Box Windows V2 SDK.
Read more about changes to Box Java SDK.

Where to get support

Should you have any issues or need further guidance, please post a request to our developer forum for any help needed.

JavaSDKs

Box Java SDK v3.8.1 released

Bug Fixes

Restoring state from previous SDK version works. (#1134) (b6d97dd)

New featuresImpactful changesAPI

Server-side actions no longer supported in Web App Integrations

On December 1st, the options to create a preliminary callback URL or a server-side integration will no longer be available for OAuth 2.0 web app integration.

Next steps

If you have the server-side integration already configured for your applications, it will still be working. If you wish to stop using the feature or perform adjustments in your settings, see this document for workaround options and support.For more information about web app integrations, see the documentation.

Where to get support

Should you have any issues or need further guidance, please post a request to our developer forum for any help needed.

PythonSDKs

Box Python SDK v3.5.1 released

Bug Fixes

Renew connection when Connection reset error occurs (#771) (bcaab27), closes #756 #757 #763 #765 #766 #770
Retry JWT auth when got error: required unique jti claim. (#768) (878e958)
Update pyjtw dependency to work with Python 3.10 (#772) (b13c5cd)

New featuresCLI

Box CLI v3.6.0 released

New Features and Enhancements

Add id and type field to shared-links:create response (#427) (5ea4cb8)
Add fields disposition_at field for files under retention (#429) (db824ef)

Bug Fixes

Fix event:poll polling-interval (#430) (9ada74b)

New featuresJavaSDKs

Box Java SDK v3.8.0 released

New Features and Enhancements

Added Box Sign webhooks (#1109) (99051a5)

Bug Fixes

NullPointerException when using BoxSignRequestPrefillTag (#1121) (73fd5b6), closes #1120
Regenerate JWT ID and retry auth request when JTI claim is rejected (#1110) (420da0f)

Dependency Upgrades

Bumped org.bitbucket.b_c:jose4j:0.9.0 (#1111) (349694d)

NodeSDKs

Box Node SDK v2.7.2 released

Bug Fixes

Add fields query parameter to file and folder update (#776) (a327deb)

New featuresiOSSDKs

Box iOS SDK v5.4.0 released

New Features and Enhancements

Add content_type field to Sign Requests signer (#871) (1ec5b01)
Add redirect_url and declined_redirect_url to Sign Request (#870) (f94d988)
Add support for sign webhook triggers (#875) (994bfaf)
Added method to remove retention policy assignment (#873) (c5f146c)
Added support for Modifiable Retention Policies (#872) (e2b7a17)

New featuresCLI

Box CLI v3.5.0 released

New Features and Enhancements

Add option to change name of downloaded file in save-asparameter (#415) (81fe64e)
Add support for modifiable retention policies & enable deleting retention policy assignment (#420) (26ab5b4)

New featuresImpactful changesAPI

Introducing Shield Information Barrier

Shield information barrier prevents communication that could lead to conflicts of interest or potential legal issues. For example, admins can use information barrier to separate teams working on different projects to prevent collaboration on content restricted to specific groups.

Shield Information Barrier API

Shield information barrier comes along with the new API that you can use to:

Create, manage, and list Shield information barriers
Create, update, delete, and list Shield information barrier segments
Create, delete, and list Shield information barrier segment restrictions
Create, delete, and list Shield information barrier segment members
Create and list Shield information barrier reports

Shield Information Barrier Events

Setting up the information barrier produces the following events:

Events triggered when the user configures the information barrier, for example activates or deactivates the barrier.
Events triggered when the user performs restricted actions, for example attempts to move an item to a restricted folder or add a user to a restricted group.

For a list of all events, see the Shield information barrier event triggers reference.

Where to get support

Should you have any issues or need further guidance, please post a request to our developer forum for any help needed.

NodeSDKs

Box Node SDK v2.7.1 released

Bug Fixes

Export missing RetentionType (#774) (7e6b244)

New featuresNodeSDKs

Box Node SDK v2.7.0 released

New Features and Enhancements

Add support for modifiable retention policies & enable deleting retention policy assignment (#769) (5e8c776)

New featuresImpactful changesUI Elements

Box UI Elements v16.0.0 released

16.0.0 (2022-10-20)

Bug Fixes & Features

This release fixes several bugs and adds new features. For a full list of changes, see the release notes.

Impactful changesAPI

Manage webhooks V2 in the developer console

Managing webhooks in your applications is now easier and more streamlined. In one single-stop UI - the Webhooks tab in the Developer Console - you can review all webhooks in an application. You can now create, update, or delete V2 webhooks using the user interface in the Developer Console.

Where to get support

Should you have any issues or need further guidance, please post a request to our developer forum for any help needed.

New featuresImpactful changesAPI

New annotations in the Content Preview UI Element

To improve the content previewing experience, we have added support for new annotations types in the Preview UI Element. End users previewing content in custom applications can now utilize additional annotation types, such as text highlight, drawing, and more. All the annotations sync in real time.

Where to get support

Should you have any issues or need further guidance, please post a request to our developer forum for any help needed.

New featuresWindowsSDKs

Box Windows SDK v4.6.0 released

New Features and Enhancements

Add redirect_url and declined_redirect_url to Sign Request (#853) (5ef2f18)
Add support for modifiable retention policies & enable deleting retention policy assignment (#856) (564904f)

Impactful changesCLI

Extract metadata with the new Box CLI script

Box CLI now features a new script that allows you to extract metadata details for all Box files and folders and save it in a CSV file.

Where to get support

Should you have any issues or need further guidance, post a request to our developer forum for any help needed.

JavaSDKs

Box Java SDK v3.7.1 released

Bug Fixes

Better logging when JSON cannot be parsed (#1106) (5e66ef8)

New featuresCLI

Box CLI v3.4.0 released

New Features and Enhancements

Add DryRun mode in User Deprovision example script (#392) (584a30e)
Add redirect_url and declined_redirect_url to Sign Request (#395) (261b7d2)
Add progress bar for file download and bulk command (#376) (68359c7)
create destination path during download (#393) (40881dd)
native credentials storage for Windows with a new library (#385) (a6918aa)

Bug Fixes

correctly resolve home dir in folders download (#398) (86d3230)
Fix logs in Users Deprovisioning script (#381) (c85f77b)
Fix problem with keytar library (#394) (1979f01)

Note

To migrate storing Box CLI environments to the system credential storage, execute the following command in the terminal (#295) box configure:environments:update

New featuresPythonSDKs

Box Python SDK v3.5.0 released

New Features and Enhancements

Add redirect_url and declined_redirect_url fields to Sign Request (#752) (5d1f609)
Add support for modifiable retention policies & enable deleting retention policy assignment (#759) (847301b)
Support file request APIs (#747) (71895e3)

Bug Fixes

Do not log the content of downloaded file (#760) (5d26431)
Fix closing file after chunked upload (#761) (b433692)

New featuresNodeSDKs

Box Node SDK v2.6.0 released

New Features and Enhancements

Add content_type, redirect_url field to Sign Request (#758) (8abb9b6)
Add sign request webhook (#760) (e92d1ab)
Added support for Access Only Collaboration (#759) (dd8261f)

New featuresJavaSDKs

Box Java SDK v3.7.0 released

New Features and Enhancements

Add is_accessible_via_shared_link field to File and Folder (#1103) (45e9906)

Bug Fixes

BoxCollaboration.getItem() returns BoxItem.Info not BoxFolder.Info (#1102) (135850d), closes #1101 #1100. BoxCollaboration.getItem() used to return BoxFolder.Info. However, if collaboration was added on a file it would still return BoxFolder.Info which will end with throwing BoxAPIException when doing any API call. If you are getting collaboration item it is best to store it as BoxItem.Info or check its type and store it as BoxFile.Info or BoxFolder.Info.
Add missing constructor to BoxNotificationEmail class (#1098) (2534f34)

New featuresImpactful changesAPI

Improved Guides on Chunked Uploads

To improve your experience with uploading large files in chunks, our guides now provide additional details on the process and support each step with examples.Check out the Upload Part guide a to get the details on how to effectively split files and upload them in several parts using Box API.

Where to get support

Should you have any issues or need further guidance, please post a request to our developer forum for any help needed.

New featuresJavaSDKs

Box Java SDK v3.6.0 released

New Features and Enhancements

Add support for modifiable retention policies & enable deleting retention policy assignment (#1093) (30e2fcb)

Bug Fixes

Stop sending not specified optional fields when creating a user (#1095) (b7d894d)

New featuresImpactful changesAPICLI

Box CLI Advanced Features YouTube Video Released

Back in February, we launched the OAuth 2.0 version of the Box CLI, alongside new YouTube content. Today, we released video 3 of the series. It shows using the as-user header and bulk command options.You can find the Box Platform and Developer Playlist on YouTube. We have one more video planned for this series: CLI Automation using PowerShell.Make sure to subscribe to the Box Channel to get all the latest content!

Where to get support

Should you have any issues or need further guidance, please post a request to our developer forum for any help needed.

Impactful changesAPI

Box Sign available for Starter plans

Box Sign is now available for Free, Personal Pro, and Starter plans.

Where to get support

Should you have any issues or need further guidance, please post a request to our developer forum for any help needed.

New featuresJavaSDKs

Box Java SDK v3.5.0 released

New Features and Enhancements

Add content-type sign request and response (#1087) (49411aa)
Add notification_email to BoxUser (#1088) (5477223)
Add redirect_url and declined_redirect_url to sign request response (#1089) (3921fe1)

Bug Fixes

Fixed canceling sign request fails because of empty body (#1085) (32b8e79)

New featuresImpactful changesCLI

Updates to Box CLI

The recent additions to the Box CLI script library and Box CLI with JWT Authentication improve automation even further and simplify handling repetitive tasks.

New CLI scripts

The sample scripts library now includes the following scripts for you to use:

Provision users and folders builds an onboarding folder structure and adds users.
Manage groups and collaborations creates or updates groups, add users to them, and finally add groups to folders as collaborators.
Report inactive users generates a CSV file with a list of users who have been inactive for a specific number of days.
Update user zones provisions users to a specific data residency zone within a Multizone Box tenant.
Deprovision users removes users.

Bulk commands guide

The bulk commands guide explains how you can use a single command to perform actions involving multiple items.

Developer Resources

Are you interested in creating applications for the Box App Center or becoming a Box Partner? Check out the Box Partner Resources guides for more information!

Where to get support

Should you have any issues or need further guidance, please post a request to our developer forum for any help needed.

New featuresWindowsSDKs

Box Windows SDK v4.5.0 released

New Features and Enhancements

Add content-type field to sign request (#850) (054d3e1)
expose effective_access in BoxSharedLink #843 (d84ddd4)

Bug Fixes

fix null reference exception when it’s not possible to get runtime version from the assembly (#851) (77046fb)
replace infinite retries with exponential backoff strategy in file representations (#835) (f2a5713)

New featuresiOSSDKs

Box iOS SDK v5.3.0 released

New Features and Enhancements

add version_number to FileVersion (#853) (ac81667)
Add support for async API in FoldersModule (#851) (58b9dde)
Add support for file request API (#867) (ec7813e)
Add support for upload and delete Avatar API (#863) (1e967f5)
Add support of Editable Shared Link (#861) (bc6ea18)
Expose send() method public in BoxClient (#843) (23caaca)

Bug Fixes

Respect Content-Type coming from custom headers (#841) (a7c69a7)

New featuresJavaSDKs

Box Java SDK v3.4.0 released

New Features and Enhancements

Added pagination for getting items in trash with new BoxTrash#items API (#1072) (9cd411d)

Bug Fixes

buffered body write and fixed SDK logging (#1079) (bc35ef3)

New featuresNodeSDKs

Box Node SDK v2.5.0 released

New Features and Enhancements

Added support update and remove user avatar (#744) (aaf6175)

Bug Fixes

Fix error while generate token using OAuth (#750) (f826291), closes #286
Fix lint error in test file (#747) (3b1e10d)

CLI

Box CLI v3.3.2 released

Bug Fixes

Fix request command when calling without body (#369) (9317888)

CLI

Box CLI v3.3.1 released

Bug Fixes

Fix OAuth login (#364) (579b44b)

New featuresImpactful changesAPI

Retention policy API improvements

Recent changes to the API for retention policies and retention policy assignments allow you to remove retention policy assignments and specify the retention length and type for your policies.

Updates

Use the new DELETE endpoint to remove an existing retention policy assignment:

curl -i -X DELETE -L https://api.box.net/2.0/retention_policy_assignments/123456/
    -H 'Authorization: Bearer <ACCESS_TOKEN>' 

Specify the following parameters when creating or updating retention policies:
- retention_length: Specifies the duration in days that the retention policy will be active for after being assigned to content.
- retention_type: Specifies if the policy is modifiable or non-modifiable. This means you can either modify the retention policy in full or in a limited way depending on the need to comply with specific regulatory requirements.

Developer Resources

Are you interested in creating applications for the Box App Center or becoming a Box Partner? Check out the Box Partner Resources guides for more information!

Where to get support

Should you have any issues or need further guidance, please post a request to our developer forum for any help needed.

New featuresCLI

Box CLI v3.3.0 released

New Features and Enhancements

add editable shared link support (#350) (ab639e7)
add file requests API support (#355) (73f0490)
add possibility to set custom analytics header (#348) (5a3387f)
support —copy-instance-on-item-copy flag for update metadata template (#357) (5d8272a)
support Client Credentials Grant as authentication method (#335) (4649d8a)

New featuresNodeSDKs

Box Node SDK v2.4.0 released

New Features and Enhancements

Added support for file requests (#742) (30b2e76)
Added support of admin_logs_streaming stream type (#740) (406950a)

Bug Fixes

properly handle client errors in streams (#736) (12378d6)

New featuresImpactful changesAPI

New Box Sign webhook triggers

The Webhook Event Triggers now include the following Box Sign events you can use to trigger a version 2 webhook:

SIGN_REQUEST.COMPLETED
SIGN_REQUEST.DECLINED
SIGN_REQUEST.EXPIRED

For details on creating webhooks read this guide.

Developer Resources

Are you interested in creating applications for the Box App Center or becoming a Box Partner? Check out the Box Partner Resources guides for more information!

Where to get support

Should you have any issues or need further guidance, please post a request to our developer forum for any help needed.

Impactful changesAPI

We updated the documentation on Cross-Origin Resource Sharing (CORS).

Updates

Added information on what to do in case of the Access-Control-Allow-Origin header issues.

Where to get support

Should you have any issues or need further guidance, please post a request to our developer forum.

New featuresPythonSDKs

Box Python SDK v3.4.0 released

New Features and Enhancements

Add support for editable shared links for files (#737) (1396200)
Support uploading and deleting user avatar (#743) (fe00a9e)

New featuresJavaSDKs

Box Java SDK v3.3.0 released

New Features and Enhancements

Added support of Editable Shared Links (#1064) (9b7d60c)

Bug Fixes

Fix closed stream exception in canUpload method (#1067) (543f91c)

Impactful changes

Improvements in Web App Integrations documentation

We updated documentation on creating Web App Integrations with Custom Apps to reflect all the information from the developer console.

Updates

Added description of all elements in the App Info section.
Expanded the Callback Parameters section with information about parameter syntax.

Where to get support

Should you have any issues or need further guidance, please post a request to our developer forum.

New featuresCLI

Box CLI v3.2.0 released

New Features and Enhancements

Added support for stream type admin_logs_streaming (#337) (7596157)

Bug Fixes

Fix native storage errors (#345) (b73b841)

New featuresImpactful changesAPI

Box Sign API supports setting redirect URLs

The Box Sign API now offers new parameters to set up custom redirect URLs for users who sign or decline a sign request. This way, when integrating your application with Box Sign, you can redirect the signers back to your application or display a custom landing page.

Updates

Box Sign API provides optional parameters to pass in the request body of the Create Sign Request call:

redirect_url that redirects the user to a specific page after signing a request
declined_redirect_url that redirects the user to a specific page after declining a request

You can define redirect URLs globally for all signers and for specific signers only. For details, see the Create Sign Request guide.

Developer Resources

Are you interested in creating applications for the Box App Center or becoming a Box Partner? Check out the Box Partner Resources guides for more information!

Where to get support

Should you have any issues or need further guidance, please post a request to our developer forum for any help needed.

New featuresImpactful changesCLI

Automate tasks with Box CLI and scripts library

The Box CLI now features a sample scripts library with templates you can use to automate your tasks. For starters, we wanted to provide you with a PowerShell script that allows you to:

set up a folder structure,
create managed users,
add the users to the folder structure as collaborators.

Updates

The Box CLI quick start guide now provides instructions on using a PowerShell script to create a folder structure and collaborators.
The scripts library is where you can find all sample scripts. Currently, it includes the PowerShell script but more samples are on the way!

Developer Resources

Are you interested in creating applications for the Box App Center or becoming a Box Partner? Check out the Box Partner Resources guides for more information!

Where to get support

Should you have any issues or need further guidance, please post a request to our developer forum for any help needed.

New featuresCLI

Box CLI v3.1.0 released

New Features and Enhancements

Add —all flag for search to return all results (#336) (23ea0a5)
add unique state parameter to OAuth2 login (#292) (5ce6a40)
allow changing base URLs (#303) (e284059)
obtain oauth authorization from command line (#299) (18c88bb)
use native credential storage for MacOS and Windows (#295) (74c4922)

Bug Fixes

users:transfer-content to respect quiet flag (#288) (1d0bbab)
correctly pass copy-instance-on-item-copy flag (#285) (cd4fbf4)
Fix updating webhook triggers (#297) (09e94c3)
support large output when using json flag by replacing json.stringify (#328) (1204f2c)
Support limit flag for Box Search (#323) (0009a77), closes #322
Support OAuth with multiple redirect URIs (#302) (9fe216e)

New featuresWindowsSDKs

Box Windows SDK v4.4.0 released

New Features and Enhancements

add can_edit field to SharedLink (#831) (e0d4197)
add version_number to BoxFileVersion (#820) (f174358)
add upload and delete support for Avatar API (#829) (4dcb84a)

Bug Fixes

Fix initialization of BoxAPIException object (#828) (a298f01)
properly dispose response on exception (#819) (8415bd3)

JavaSDKs

Box Java SDK v3.2.1 released

Bug Fixes

Fix getting proper URL to authenticate with OAuth (#1059) (42876b4), closes #1057

New featuresImpactful changesAPISalesforce

New Box App Center (formally App Gallery)

You can now visit the completely updated Box App Center to find the over 1500+ integrations you already know and love. Box App Center provides a modernized catalog of apps and integrations and will be accessible from the Box Web app.For end-users, the Box App Center makes it smoother to work the way you want to, thanks to the comprehensive selection of ready-to-use integrations from partners such as Microsoft, Zoom, Salesforce, and Slack, to name a few.For IT leaders and admins, the Box App Center gives your users choice, without sacrificing security or user experience. And it eliminates shadow IT by providing a list of enterprise-approved options.Box App Center will be part of the Core Box package; The Box App Center is available to all customers today!

Developer Resources

Are you interested in creating applications for the Box App Center or becoming a Box Partner? Check out the Box Partner Resources guides for more information!

Where to get support

Should you have any issues or need further guidance, please post a request to our developer forum for any help needed.

New featuresJavaSDKs

Box Java SDK v3.2.0 released

New Features and Enhancements

Revamped setting base URLs (#1042) (129baf7)
support for Avatar V2 API (#1044) (18651d7)

New featuresImpactful changesAPI

OAuth 2.0 Redirect URL Strict Checking Enabled

Today, we turned on strict checking for all OAuth 2.0 applications.On November 29, 2021, we announced new applications using OAuth 2.0 will require the URIs set in the configuration tab of the Developer Console to strictly match the one used during redirect.This change has now been completed. If your enterprise had applications that were not following this standard, you should have received four emails over the past few months describing how to update your applications.

How to solve redirect errors

If you did not receive the email or missed the communication, below you will find the steps to mitigate any issues.

You can change the redirect URL in the Box Developer Console configuration tab for your application. If the URLs are static, then you can update the Developer console to add multiple URLs. If the URLs are dynamic, then update your application to use a static URL or use the state parameter.
You can change the redirect URL used in your application code to strictly match the URL in the developer console.

For option #1, please use these steps:

Login to Box as the application owner and navigate to the Box Developer Console
Click on the application and navigate to the configuration tab
Scroll down to the “OAuth 2.0 Redirect URI” section
Update the current URL listed

For option #2, please modify your application code to replace the impacted used URLs to strictly match the URL in the Developer Console.

Updates

Redirect URIs now force strict checking to match the URI passed in and URIs configured in the OAuth 2.0 application configuration

Where to get support

Should you have any issues or need further guidance, please post a request to our developer forum or file a ticket with Box Support.

New featuresImpactful changesAPI

New Endpoints to Manage User Avatars

Starting today, the User Avatar APIs supports adding, updating, and deleting user avatars.To create or update a user avatar, call the POST /users-id-avatar endpoint. Remember to include the path to the file you want to upload. If an avatar already exists, it will be replaced with the new photo uploaded.

curl -i -X POST -L https://api.box.net/2.0/users/userID/avatar 
    -H 'Authorization: Bearer <ACCESS_TOKEN>' 
    --form 'pic=@"path/to/file/file.jpeg"'

The response includes the user avatar object with URLs to the file location.To delete a user avatar, call the DELETE /users-id-avatar endpoint:

curl -i -X DELETE -L https://api.box.net/2.0/users/userID/avatar 
    -H 'Authorization: Bearer <ACCESS_TOKEN>'

Where to get support

Should you have any issues or need further guidance, please post a request to our developer forum for any help needed.

New featuresImpactful changesUI Elements

Box UI Elements v15.0.0 released

15.0.0 (2022-05-16)

Bug Fixes & Features

This release fixes several bugs and adds new features. For a full list of changes, please see the release notes.

New featuresImpactful changesAPI

New Field Added to Sign Requests

Box Sign request response objects now include a new field - content_type. This field identifies the type of content expected for the type of input selected for the signer to complete.

Updates

Added new field content_type to the sign request response object

Where to get support

Should you have any issues or need further guidance, please post a request to our developer forum.

New featuresImpactful changesAPI

New Fields Added to Event Specification

The Event resource specification now includes two new fields:

created_at specifying when an event was created
recorded_at specifying when an event was registered in the database

Updates

Added new fields created_at and recorded_at to the [Event] resource specification 2.

Where to get support

Should you have any issues or need further guidance, please post a request to our developer forum for any help needed.

New featuresImpactful changesAPI

New Field Added to Sign Events Payload

The additional_details Sign Events payload now includes the batch_send field identifying a sign request sent to multiple recipients at once. If such a batch send request exists, the payload also provides its id.

Updates

Added new field batch_send to additional_details payload for Sign Events.

Where to get support

Should you have any issues or need further guidance, please post a request to our developer forum for any help needed.

New featuresImpactful changesAPI

New Editable Shared Links API

Now, developers can make files editable via shared links using the API.

Documentation Updates

Added a new can_edit value to the permissions object for the file, folder, and web link resources
Added a new shared_link_permission_options field to the file--full resource
Added a shared link section for web links in the reference documentation
Added a permissions page to the shared links guide documentation
Combined the update and add shared link guide page since they utilize the same PUT endpoint
Updated code snippets across several shared link pages

Enhancement Details

Instead of having to collaborate a user into a file to give edit access, you can set the shared_link.permissions.can_edit field to true.
The can_edit field will be returned for all shared link objects on files, folders, and web links; however, you can only set it to true for a file.
Our SDK libraries will gain this feature in the coming quarters.
If an admin has turned off editable shared links in the admin console, you will not be able to use this feature.

cURL Example

curl -i -X PUT 'https://api.box.com/2.0/files/123456789?fields=shared_link' \
        -H 'Content-Type: application/json' \
        -H 'Authorization: Bearer [ACCESS TOKEN]' \
        -d '{
          "shared_link": {
            "permissions": {
              "can_preview": true,
              "can_download": true,
              "can_edit": true
            }
          }
        }'

Where to get support

Should you have any issues or need further guidance, please post a request to our developer forum for any help needed.

New featuresPythonSDKs

Box Python SDK v3.3.0 released

New Features and Enhancements

Add support for multiple date time formats (#722) (92364de)

Bug Fixes

Add missing fields to metadata template field (#719) (9e574a3), closes #717
Upload session commit return None on 202 (#718) (86a1856), closes #715

New featuresNodeSDKs

Box Node SDK v2.3.0 released

New Features and Enhancements

Add description parameter to uploadFile methods (#730) (2596584)

Bug Fixes

added missing js-docs on shared links (#731) (3554d41)

iOSSDKs

Box iOS SDK v5.2.1 Released

Bug Fixes

Expose fields from BoxResponse for custom API calls (#833) (bae1536)

New featuresImpactful changesAPI

Improvements In Platform Apps Approval Flow

Today we added further improvements to the platform apps approval flow. As a result, you can now use a new Enablement tab in Developer Console to directly request a Box Admin to enable OAuth 2.0 platform apps.Additionally, Box Admins can use Platform Apps Manager to view and enable platform apps in Admin Console.

Updates

Enablement tab was added for OAuth 2.0 platform apps.
Information on enabling OAuth 2.0 platform applications has been added to the platform app approval guide page.
Screenshots have been updated on the platform app approval and setup with OAuth 2.0 guide pages.

Where to get support

Should you have any issues or need further guidance, please post a request to our developer forum for any help needed.

New featuresNodeSDKs

Box Node SDK v2.2.0 released

New Features and Enhancements

editable shared links (#722) (f0c0135)

WindowsSDKs

Box Windows SDK v4.3.1 released

Bug Fixes

simplify base urls usage (#815) (f8e7344)

API

Notice of behavior change for collaboration events on the changes stream

Starting today, we will begin rolling out changes to the behavior of collaboration events when an application consumes those events from our event API endpoints.This change will only affect COLLAB_INVITE_COLLABORATOR, COLLAB_ADD_COLLABORATOR, COLLAB_ROLE_CHANGE, and COLLAB_REMOVE_COLLABORATOR user events with the query parameter stream_type set to changes. This will not affect existing enterprise events. The new behavior will not cause downtime within existing applications or require any application changes to prevent uptime disruptions.

Change overview

Previously, events of type COLLAB_INVITE_COLLABORATOR, COLLAB_ADD_COLLABORATOR, COLLAB_ROLE_CHANGE, and COLLAB_REMOVE_COLLABORATOR created notifications for the acted upon users that were listening to the changes stream. Owners of the collaborated item would not receive these events unless they were listening to the all stream as well.We are cleaning up this discrepancy by establishing parity between the all and changes stream. With this new behavior, notifications of a collaboration will be created for the content owner on the changes stream as well. Collaboration owners will now see an additional event that matches what they see on the all stream.

Where to get support

Should you have any issues or need further guidance, please post a request to our developer forum for any help needed.

New featuresWindowsSDKs

Box Windows SDK v4.3.0 released

New Features and Enhancements

add SourceLink support for Core project (#795) (a9cbede)

Bug Fixes

add missing enum to string parsing in several places (#813) (e370282)
properly cast response when uploading a new file version using session (#810) (73d877f)

New featuresNodeSDKs

Box Node SDK v2.1.0 released

New Features and Enhancements

Client Credentials Grant authentication method (#709) (fbf4e80)
Deprecating index_name when executing metadata query (#686) (e01cc65)
test: add support for testing with Jest (#676) (1a11759)

Bug Fixes

Client Credentials Grant authentication method supports token down-scoping (#710) (730368f)
Fix JWT expiration field being float instead of integer (#715) (7e950f1), closes #713

New featuresImpactful changesAPI

New Search API Query Parameter

Now, you can filter searching for content in the API using the new field recent_updater_user_ids.

Updates

Added new query parameter recent_updater_user_ids to the GET /get-search API endpoint

Features

Limits the search results to any items that have been updated by the given list of users, defined as a list of comma separated user IDs.
This feature only searches back to the last 10 versions of an item.

cURL Example

curl -i -X GET "https://api.box.com/2.0/search?query=sales&recent_updater_user_ids=1234567890,2314567890" \
     -H "Authorization: Bearer <ACCESS_TOKEN>"

Where to get support

Should you have any issues or need further guidance, please post a request to our developer forum for any help needed.

JavaSDKs

Box Java SDK v3.1.2 Released

Bug Fixes

Allow using As-User header with CCG Authentication (#1031) (b0c2389)
Fix retry logic when Retry-After header is present (#1033) (05224c4)

New featuresiOSSDKs

Box iOS SDK v5.2.0 released

New Features and Enhancements

Add disposition_at field to the File object (#814) (3c90df0)
Add support for Client Credentials Grant authentication method (#821) (f6d7542)

New featuresImpactful changesAPICLI

New Box CLI YouTube Video

Back in February, we launched the OAuth 2.0 version of the Box CLI, alongside new YouTube content. Today, we released video 2 of the series. It shows using the built in help functionality to create a folder with the CLI.You can find the Box Platform and Developer Playlist on YouTube. We have two more videos planned: Advanced Topics (including as-user) and CLI Automation using PowerShell.Make sure to subscribe to the Box Channel to get all the latest content!

Where to get support

Should you have any issues or need further guidance, please post a request to our developer forum for any help needed.

New featuresImpactful changesAPINodePythonJavaWindowsCLIiOSSDKs

Announcing SDK Supported Versions

Starting July 30 2022, only the current major version of a SDK will be supported. New features, functionality, bug fixes, and security updates will only be added to the current major version.A current release is on the leading edge of our SDK development, and is intended for customers who are in active development and want the latest and greatest features. Instead of stating a release date for a new feature, we set a fixed minor or patch release cadence of maximum 2-3 months (while we may release more often). At the same time, there is no schedule for major or breaking release. Instead, we will communicate one quarter in advance the upcoming breaking change to allow customers to plan for the upgrade. We always recommend that all users run the latest available minor release for whatever major version is in use. We highly recommend upgrading to the latest SDK major release at the earliest convenient time and before the EOL date.We use a modified version of Semantic Versioning for all changes. See version strategy for details.

Supported version for each SDK

Below find links to the charts of supported versions for all SDKs.

Where to get support

Should you have any issues or need further guidance, please post a request to our developer forum for any help needed.

New featuresPythonSDKs

Box Python SDK v3.2.0 released

New Features and Enhancements

Add setting disposition_at field for files under retention (#710) (91b1373)
Add support for Client Credentials Grant authentication method (#705) (d33d16d)

Bug Fixes

Add missing box_sign object to __all__ list (#708) (5d80481)
Fix jwt import errors (#711) (ee7bb6f)

New featuresImpactful changesAPI

Developer Documentation Updates

Today, we released several updates and bug fixes to our developer documentation. Click below to find out more information!

Updates

Added additional trailing backslashes for metadata query examples
Removed extra quotes from metadata query examples
Updated and added examples for Shield Smart Access events
Added note to the can_view_path field
Corrected trash resources to represent the right responses returned by the API
Added an iOS filter to the changelog
Added note to folder lock endpoint
Added note to developer token guide that says revoking token removes webhook
Removed the 94x94 option from the thumbnail endpoint
Added note to the events limit parameter
Added note to the user login parameter
Added app users to the PUT user endpoint
Added external_app_user_id field to the PUT user endpoint
Changed all references throughout documentation of X-REF-HINTS to x-rep-hints
Added new fields to all 11 Box Sign events

Where to get support

Should you have any issues or need further guidance, please post a request to our developer forum for any help needed.

JavaSDKs

Box Java SDK v3.1.1 released

Bug Fixes

retry jwt auth when error code is in error field (#1020) (8c9d11d), closes #1019

New featuresJavaSDKs

Box Java SDK v3.1.0 released

New Features and Enhancements

Added support for Client Credentials Grant authentication method (#1002) (9cfcaff)
API to extend disposition date on a file (#1001) (f3f6b60)
Deprecating indexName when executing metadata query (#1000) (c20dbbf)

Dependency Upgrades

Upgrade Gradle to 7.3.3 (#985) (e4acbb1)

New featuresImpactful changesAPIWindows

Client Credentials support in the SDKs

Our .NET and Java SDKs now support Client Credentials Grant authentication. We plan to release the support for the other SDKs in the coming weeks.Back in November 2020, we released a new authentication type for custom applications called Client Credentials. Today, we have started releasing SDK support for the new type.

Updates

Added new sample tags and examples on our Client Credentials guide page.

Where to get support

Should you have any issues or need further guidance, please post a request to our developer forum for any help needed.

New featuresPythonSDKs

Box Python SDK v3.1.0 released

New Features and Enhancements

Add support for Python 3.10 (#692) (d4aed82)
Add support for Python 3.8, Python 3.9, pypy-3.7 and pypy-3.8. (#689) (0aa94cc)
Deprecate use_index parameter from MDQ of files/folders (#666) (2595720)
Replace external package mock with Python standard library unittest.mock (#697) (6fd6366)
Upgrade cryptography library to the most recent version. (#668) (9c94d08), closes #667

Bug Fixes

UploadSession.commit returns None when retry limit was reached (#696) (9456fe0)
Add missing api_call decorator for create_upload_session (#686) (3510d3a)
Fix chunked upload (#673) (2605fd7), closes #671

New featuresAPI

New Box Shield Access Policy Monitoring Mode

Recently, Box Shield added a new feature that allows admins to test out Access Policies with a new monitoring mode.

Updates

Added the new controlMode field to all events in the Smart Access events section
Added application and FTP restriction information in the Smart Access events section

Where to get support

Should you have any issues or need further guidance, please post a request to our developer forum for any help needed.

New featuresWindowsSDKs

Box Windows SDK v4.2.0 released

Bug Fixes

correctly pass null when rolling out user from the enterprise (#792) (c85c573)
Creating BoxAuthenticationFailedException no longer throws an exception (#790) (55a706e)
Null Argument Exception in AutoPaginate (#666) (c61f08c)

New Features and Enhancements

add admin_logs_streaming support (#797) (a775e1e)
add Client Credentials Grant auth support (#799) (b8a64ca)
add disposition_at field to the File object (#793) (2766a91)
add possibility to set auth token uri in BoxConfig (#794) (ae8cd8b)
deprecate index_name in ExecuteMetadataQuery (#800) (6a6a0e4)

Impactful changesUI Elements

EOL Notification For DICOM

Box has retired (End of Life/EOL) our DICOM Uploader and turned off native previewing of boxdicom studies as of December 31, 2021.The developer documentation for DICOM has now been removed. For more information, please see the product announcement for alternatives.

Where to get support

Should you have any issues or need further guidance, please post a request to our developer forum for any help needed.

New featuresImpactful changesCLI

Box CLI v3.0.0 released

Today, we released v3.0.0 of the Box CLI. This release has several enhancements, most notably - addition of OAuth 2.0 support.In addition to CLI enhancements and documentation changes, we also released a brand new YouTube video that shows using our Box CLI Quick Start to get started with the CLI in less than five minutes!

Developer Documentation Changes

Updated the Box CLI Quick Start Guide to use the OAuth 2.0 Authentication method
Moved the JWT setup steps to an appendix

New Features and Enhancements

Add support for login with OAuth (#240)
feat: support as-user flag for bulk files and when token is present (#270)
Add support for copyInstanceOnItemCopy field for metadata templates (#239)
Add support note to the mdfilter equality check in search (#253)
Add support for Box Sign API (#258)
Add support Metadata Query API (#259)
fix: folder:collaborations:add make role a required flag (SDK-1070) (#261)
Minor dependencies upgrade
Add new API for files and file versions under retention (#250)
Adding support for sign request (#258)
Support Metadata Query API (#259)
chore: enforce conventional commits (#268)
feat: support as-user flag for bulk files and when token is present (#270)

Breaking Changes

Drop support for Node 10
Insensitive language changes (#247, #252)

Bug Fixes

fix: folder:collaborations:add make role a required flag (#261)
fix: Fixed shared-links delete example. (#262)

Where to get support

Should you have any issues or need further guidance, please post a request to our developer forum for any help needed. You can also connect with the SDK team on the respective GitHub repository.

PythonSDKs

Box Python SDK v3.0.1 released

Bug Fixes

Move sphinx to test requirements (#662)

New featuresImpactful changesPythonSDKs

Box Python SDK v3.0.0 released

Breaking Changes

Drop support for python 2.7 (#645)
Add missing parameter stream_position to get_admin_events method (#648)
Drop support for python 3.5 (#654)
Remove deprecated code using insensitive language (#651)
Enforcing usage of keyword-only arguments in some functions (#656)

New Features and Enhancements

Remove six library and __future__ imports (#646)
Add type hints to method parameters (#650)

Bug Fixes

Add missing api_call decorators on multi-input calls (#653)
Added py.typed file for mypy to recognize type hints (#657)

New featuresImpactful changesJavaSDKs

Box Java SDK v3.0.0 released

Breaking changes

Changed BoxFileVersion class and removed fileVersion field (#978)
Removed deprecated API BoxCollaborationWhitelist replaced with BoxCollaborationAllowlist, BoxCollaborationWhitelistExemptTarget replaced with BoxCollaborationAllowlistExemptTarget (#969)
Dropping Java 7 support (#962)
Downgrading bouncycastle libraries to 1.57 (#942)

New Features and Enhancements

Add typeName to BoxEvent that contains name of the event, even if it is not mapped to BoxEvent.EventType (#979) (b30f61f), closes #968
Add new optional description parameter to the retention_policies endpoint and start_date_field to the retention_policy_assignments endpoint. (#967) (0aa4ff4)
Adding BoxFile#getVersions(String... fields) to allow users to specify what information they want to extract. Fixes #946. (#947) (a2eb638)
Missing eventTypes from BoxAPI Documents. Fixes #974 (#975) (2c69360)
Removed deprecated API BoxCollaborationWhitelist replaced with BoxCollaborationAllowlist, BoxCollaborationWhitelistExemptTarget replaced with BoxCollaborationAllowlistExemptTarget (#969) (2fd4d6f)

Bug Fixes

Changed BoxFileVersion class and removed fileVersion field (#978) (8c39451)
Changed SDK loggers name to "com.box.sdk", fixes #638 (#950) (443c230)
Date parsing error when BoxSignRequestPrefillTag created with date value. (#970) (cc2c8da)
Fix sending limit parameter in EventLog (#977) (96bdccc)
Fixed NullPointerException when empty metadata used on BoxFile or BoxFolder (#918) (#945) (68bc3c5)
Cannot deseralize sign request, fixes issue (#951). (#952) (070bdc5)

Dependency Upgrades

Dropping Java 7 support (#962) (953ad78)
Downgrading bouncycastle libraries to 1.57 (#942) (26aaed5)

New featuresiOSSDKs

Box iOS SDK v5.1.0 Released

New Features and Enhancements

Allow to customize URL for the OAuth2 authorization page (#811) (1901d29)
Events: Add support for admin_logs_streaming stream type (#800) (0a3118e)
RetentionPolicy: New API for get files and file versions under retention (#807) (38327f0)
SharedLink: add support for vanity_name (#799) (3ea6eb2)

Bug Fixes

SignRequest: Fix encoding date_value to yyyy-mm-dd format in prefillTag (#806) (4f902a4)

New featuresImpactful changesAPI

New Features For Platform App Management

Today, we released changes to the Platform Apps Manager section of the Box Admin Console. Now, you can more easily view and manage enablement of platform OAuth 2.0 Applications.In addition to adding new functionality, we also made updates to the UI of the Platform Apps Manager. For more information on the changes and authorizing apps that use the Box API, check out the blog post.

Updates

Screenshots have been updated on the authorization, platform app approval, limited access approval, and security guide pages
Information on the OAuth 2.0 platform application approval process has been added to the platform app approval guide page

Where to get support

Should you have any issues or need further guidance, please post a request to our developer forum for any help needed.

​Box Node SDK v2.8.0 released

​New Features and Enhancements

​Announcing major releases of Box SDKs

​Where to get support

​Box Java SDK v3.8.1 released

​Bug Fixes

​Server-side actions no longer supported in Web App Integrations

​Next steps

​Where to get support

​Box Python SDK v3.5.1 released

​Bug Fixes

​Box CLI v3.6.0 released

​New Features and Enhancements

​Bug Fixes

​Box Java SDK v3.8.0 released

​New Features and Enhancements

​Bug Fixes

​Dependency Upgrades

​Box Node SDK v2.7.2 released

​Bug Fixes

​Box iOS SDK v5.4.0 released

​New Features and Enhancements

​Box CLI v3.5.0 released

​New Features and Enhancements

​Introducing Shield Information Barrier

​Shield Information Barrier API

​Shield Information Barrier Events

​Where to get support

​Box Node SDK v2.7.1 released

​Bug Fixes

​Box Node SDK v2.7.0 released

​New Features and Enhancements

​Box UI Elements v16.0.0 released

​16.0.0 (2022-10-20)

​Bug Fixes & Features

​Manage webhooks V2 in the developer console

​Where to get support

​New annotations in the Content Preview UI Element

​Where to get support

​Box Windows SDK v4.6.0 released

​New Features and Enhancements

​Extract metadata with the new Box CLI script

​Where to get support

​Box Java SDK v3.7.1 released

​Bug Fixes

​Box CLI v3.4.0 released

​New Features and Enhancements

​Bug Fixes

​Note

​Box Python SDK v3.5.0 released

​New Features and Enhancements

​Bug Fixes

​Box Node SDK v2.6.0 released

​New Features and Enhancements

​Box Java SDK v3.7.0 released

​New Features and Enhancements

​Bug Fixes

​Improved Guides on Chunked Uploads

​Where to get support

​Box Java SDK v3.6.0 released

​New Features and Enhancements

​Bug Fixes

​Box CLI Advanced Features YouTube Video Released

​Where to get support

​Box Sign available for Starter plans

​Where to get support

​Box Java SDK v3.5.0 released

​New Features and Enhancements

​Bug Fixes

​Updates to Box CLI

​New CLI scripts

​Bulk commands guide

​Developer Resources

​Where to get support

​Box Windows SDK v4.5.0 released

​New Features and Enhancements

​Bug Fixes

​Box iOS SDK v5.3.0 released

​New Features and Enhancements

​Bug Fixes

Box Node SDK v2.8.0 released

New Features and Enhancements

Announcing major releases of Box SDKs

Where to get support

Box Java SDK v3.8.1 released

Bug Fixes

Server-side actions no longer supported in Web App Integrations

Next steps

Where to get support

Box Python SDK v3.5.1 released

Bug Fixes

Box CLI v3.6.0 released

New Features and Enhancements

Bug Fixes

Box Java SDK v3.8.0 released

New Features and Enhancements

Bug Fixes

Dependency Upgrades

Box Node SDK v2.7.2 released

Bug Fixes

Box iOS SDK v5.4.0 released

New Features and Enhancements

Box CLI v3.5.0 released

New Features and Enhancements

Introducing Shield Information Barrier

Shield Information Barrier API

Shield Information Barrier Events

Where to get support

Box Node SDK v2.7.1 released

Bug Fixes

Box Node SDK v2.7.0 released

New Features and Enhancements

Box UI Elements v16.0.0 released

16.0.0 (2022-10-20)

Bug Fixes & Features

Manage webhooks V2 in the developer console

Where to get support

New annotations in the Content Preview UI Element

Where to get support

Box Windows SDK v4.6.0 released

New Features and Enhancements

Extract metadata with the new Box CLI script

Where to get support

Box Java SDK v3.7.1 released

Bug Fixes

Box CLI v3.4.0 released

New Features and Enhancements

Bug Fixes

Note

Box Python SDK v3.5.0 released

New Features and Enhancements

Bug Fixes

Box Node SDK v2.6.0 released

New Features and Enhancements

Box Java SDK v3.7.0 released

New Features and Enhancements

Bug Fixes

Improved Guides on Chunked Uploads

Where to get support

Box Java SDK v3.6.0 released

New Features and Enhancements

Bug Fixes

Box CLI Advanced Features YouTube Video Released

Where to get support

Box Sign available for Starter plans

Where to get support

Box Java SDK v3.5.0 released

New Features and Enhancements

Bug Fixes

Updates to Box CLI

New CLI scripts

Bulk commands guide

Developer Resources

Where to get support

Box Windows SDK v4.5.0 released

New Features and Enhancements

Bug Fixes

Box iOS SDK v5.3.0 released

New Features and Enhancements

Bug Fixes